fragment.pos.catalog
Syntax
- v = fragment.pos.catalog(fg,ic)
Get the fragment position at a state. The fragment position is taken as the average position of the bodies. The fragment position in catalog ic is returned, where ic ranges from 1 to the total number of catalogs. Use the
fragment.catalog
function or thefragment list
command to obtain the catalog information. Thefragment.catalog
function can be used to obtain the catalog number closest to a specified time.Returns: v - fragment position vector
Arguments: fg - fragment pointer
ic - catalog number
Component Access
f = fragment.pos.catalog
(fg)->x
- f = fragment.pos.catalog.x(fg,ic)
Get the x-component of the fragment position.
Returns: f - x-component of the fragment position vector
Arguments: fg - fragment pointer
ic - catalog number
Access other vector components (y, z (3D ONLY)) by substituting the component name where x appears above. See Member Access Operator for information about accessing members from data types using ->
.
Deprecated Component Access
Component access by adding an optional integer in the function arguments (e.g., f = fragment.pos.catalog(frag, 1, 3)
) is deprecated. It remains available but will not be supported in future versions. See Component Access with Integers in FISH on the Deprecated Commands and FISH page for details.
Was this helpful? ... | FLAC3D © 2019, Itasca | Updated: Feb 25, 2024 |