contact history command
Syntax
- contact history <id id > s keyword ...
Primary keywords:
force force-x force-y force-z gap localforce-y localforce-z localmomenton1-x localmomenton1-y localmomenton1-z localmomenton2-x localmomenton2-y localmomenton2-z mechanical momenton1 momenton1-x momenton1-y momenton1-z momenton2 momenton2-x momenton2-y momenton2-z normalforce position-x position-y position-z shearforce thermal
Add a contact history. A history is a floating point variable that can be sampled and stored during a model run. The optional id directly following history creates a history with the specified ID. If not specified, then the next available history ID is used. The s value identifies the contact type (i.e., contact-contact, contact-pebble, contact-facet, or pebble-facet). Following one of the keywords given below, either 1) a position vector or 2) an additional id keyword must be given to define the specific contact. See the [contacthistoryblock] below for details regarding the manipulation of contact histories.
By default, only active mechanical contacts are considered.
- force [contacthistoryblock]
Magnitude of the contact force.
- force-x [contacthistoryblock]
The \(x\)-component of the contact force.
- force-y [contacthistoryblock]
The \(y\)-component of the contact force.
- force-z (3D ONLY) [contacthistoryblock]
The \(z\)-component of the contact force.
- gap [contacthistoryblock]
Contact gap.
- localforce-x [contacthistoryblock]
The \(x\)-component of the contact force in the contact coordinate system.
- localforce-y [contacthistoryblock]
The \(y\)-component of the contact force in the contact coordinate system.
- localforce-z (3D ONLY) [contacthistoryblock]
The \(z\)-component of the contact force in the contact coordinate system.
- localmomenton1-x (3D ONLY) [contacthistoryblock]
The \(x\)-component of the contact moment on end 1 in the contact coordinate system.
- localmomenton1-y (3D ONLY) [contacthistoryblock]
The \(y\)-component of the contact moment on end 1 in the contact coordinate system.
- localmomenton1-z (3D ONLY) [contacthistoryblock]
The \(z\)-component of the contact moment on end 1 in the contact coordinate system.
- localmomenton2-x (3D ONLY) [contacthistoryblock]
The \(x\)-component of the contact moment on end 2 in the contact coordinate system.
- localmomenton2-y (3D ONLY) [contacthistoryblock]
The \(y\)-component of the contact moment on end 2 in the contact coordinate system.
- localmomenton2-z (3D ONLY) [contacthistoryblock]
The \(z\)-component of the contact moment on end 2 in the contact coordinate system.
- mechanical [contacthistoryblock]
Apply to mechanical contacts.
- momenton1 [contacthistoryblock]
The {contact moment on end 1 in 2D; magnitude of the contact moment on end 1 in 3D}.
- momenton1-x (3D ONLY) [contacthistoryblock]
The \(x\)-component of the contact moment on end 1.
- momenton1-y (3D ONLY) [contacthistoryblock]
The \(y\)-component of the contact moment on end 1.
- momenton1-z (3D ONLY) [contacthistoryblock]
The \(z\)-component of the contact moment on end 1.
- momenton2 [contacthistoryblock]
The {contact moment on end 2 in 2D; magnitude of the contact moment on end 2 in 3D}.
- momenton2-x (3D ONLY) [contacthistoryblock]
The \(x\)-component of the contact moment on end 2.
- momenton2-y (3D ONLY) [contacthistoryblock]
The \(y\)-component of the contact moment on end 2.
- momenton2-z (3D ONLY) [contacthistoryblock]
The \(z\)-component of the contact moment on end 2.
- normalforce [contacthistoryblock]
Contact force in the normal direction.
- position-x [contacthistoryblock]
The \(x\)-component of the contact position.
- position-y [contacthistoryblock]
The \(y\)-component of the contact position.
- position-z (3D ONLY) [contacthistoryblock]
The \(z\)-component of the contact position.
- shearforce [contacthistoryblock]
Magnitude of the shear contact force.
- thermal [contacthistoryblock]
Apply to thermal contacts.
contact history Keyword Block
The following modifiers are available to specify addition information for the contact history keywords. They will not modify history values to which they are not applicable. In other words, the component keyword will not modify scalar or tensor values. force, force-x, force-y, force-z, gap, localforce-y, localforce-z, localmomenton1-x, localmomenton1-y, localmomenton1-z, localmomenton2-x, localmomenton2-y, localmomenton2-z, mechanical, momenton1, momenton1-x, momenton1-y, momenton1-z, momenton2, momenton2-x, momenton2-y, momenton2-z, normalforce, position-x, position-y, position-z, shearforce and thermal. localforce-x.
- component keyword
This keyword selects which scalar to retrieve from a vector type value, such as velocity or displacement. If the value type is not a vector, this setting is ignored. The available options are:
- x
Record the \(x\)-component of the vector.
- y
Record the \(y\)-component of the vector.
- z (3D ONLY)
Record the \(z\)-component of the vector.
- magnitude
Record the vector magnitude.
- index i
For keywords that require it (most notably extra), this specifies the index that should be used.
- log b
If on, the returned number is the base 10 log of the absolute value of the original value. The default is off.
- type keyword
In certain cases the type (scalar, vector, or tensor) of the value cannot necessarily be determined ahead of time. Extra variables, for example, can hold values of all three types. This keyword allows one to specify which type it is assumed to be. If the original value type does not match, 0.0 is returned.
- scalar
Specify a scalar float type.
- tensor
Specify a tensor type.
- vector
Specify a vector type.
Usage Example
contact history ball-ball force-x id 1
contact history ball-ball force position 0.0,0.0,0.0
| Was this helpful? ... | Itasca Software © 2024, Itasca | Updated: Dec 19, 2024 |
