contact list command

Syntax

contact list <keyword ...> <range>

Primary keywords:

all    domain    energy    energylist    extra    force    group    mechanical    methodlist    model    modellist    moment    normal    property    propertylist    shear    thermal    type

List contact information. By default, the contact ID, type, ID of the end1 piece, ID of the end2 piece, activity state, inhibited state, and position are listed. By default, only active contacts are listed. Use the all keyword to list active and inactive contacts.

Also, by default, contacts of all types are listed. Use the type keyword to filter by contact type. For instance, if s = ball, then all ball-ball, ball-pebble, and ball-facet contacts are listed. If s = ball-ball, only ball-ball contacts are listed.

By default, only mechanical contacts are considered. If sprocess is specified, then it must correspond to a process name and contacts within this process are considered.

Note

Use the model precision command to change the precision of listed floating point values.

all

List active and inactive contact information.

domain

List information about domain contacts.

energy <s >

List the energies of a contact model used by the contact. If s is not specified, then all energy names and values are listed for each contact. If s is specified, then only that energy is listed for the specified contacts. Use the energylist keyword to list all energies available for each contact model.

energylist

List the energies available in each contact model. By default, these energies are not tabulated. See the model energy command for further details.

extra i

List the contact extra variables at index i.

force <local>

List the contact force in the global coordinate system. This is the contact force (\(\mathbf{F_c}\)) acting at the body (i.e., ball, clump, or wall) centroid to which the end2 piece (i.e., ball, pebble, or facet) belongs. Give the local keyword to list the contact force in the local coordinate system of the contact. In this case, a vector is returned that is { \((-F_n,F_{st})\) in 2D; \((-F_n,F_{ss},F_{st})\) in 3D} where \(\mathbf{F_c}=-F_n \hat{\mathbf{n_c}} + F_{ss} \hat{\mathbf{s_c}} + F_{st} \hat{\mathbf{t_c}}\) where \(F_{ss} \equiv 0\) in 2D. The orientation of this system can be listed with the normal and shear keywords.

group i

List the contact group names at slot i.

mechanical

List quantities related to mechanical contacts.

methodlist

List all available contact models, their available methods, and the names of the method arguments. Contact model methods are distinct from contact model properties in that they operate on one or more contact model properties based on, perhaps, the contact geometry or piece attributes.

model

List the contact model name for each contact.

modellist

List all available contact models, whether or not they have been loaded as plugin contact models, and their property names. This is a synonym for the propertylist keyword.

moment <local>

List the contact moments in the global coordinate system. These are the total moments, \(\mathbf{M}^{(1)}\) and \(\mathbf{M}^{(2)}\), acting on the bodies to which the pieces end1 and end2 belong, respectively. Give the local keyword to list the contact moments in the local coordinate system of the contact. The orientation of this system can be listed with the normal and shear keywords.

normal

List the contact normal direction, pointing from the end1 piece to the end2 piece. This is the direction in which the normal force is acting and is denoted as \(\hat{\mathbf{n_c}}\).

property <s >

List the properties of a contact model used by the contact. If s is not specified, then all property names, inheritance state, and values are listed for each contact. If s is specified, then only that property is listed for the specified contacts. Use the propertylist keyword to list contact models and all properties available.

propertylist

List all available contact models, whether or not they have been loaded as plugin contact models, and their property names. This is a synonym for the modellist keyword.

shear

List the contact shear direction. In 2D, this corresponds to the direction orthogonal to the normal direction termed \(\hat{\mathbf{t_c}}\). In 3D, on the other hand, this is the direction of the second unit vector forming the local axis system of the contact in global coordinates termed \(\hat{\mathbf{s_c}}\). The third unit vector can be obtained from the cross product of the normal and this value.

thermal

List quantities related to thermal contacts.

type s

Filter by contact type.

Usage Example

contact list all

contact list extra 1

contact list force