clump.pos
Syntax
- v = clump.pos(cp)
- clump.pos(cp) = v
Get/set the clump position.
Returns: v - clump position vector Accepts: v - clump position vector Arguments: cp - clump pointer
Component Access
f = clump.pos
(cp)->x
clump.pos
(cp)->x
= f
- f = clump.pos.x(cp)
- clump.pos.x(cp) = f
Get/set the \(x\)-component of the clump position.
Returns: f - \(x\)-component of the clump position vector Accepts: f - \(x\)-component oof the clump position vector Arguments: cp - clump pointer
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 = clump.pos(cp,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? ... | PFC © 2021, Itasca | Updated: Feb 25, 2024 |