clump.template.origpos

Syntax

v = clump.template.origpos(cp)
clump.template.origpos(cp) = v

Get/set the clump template original position.

Returns:v - clump template original position vector or component
Accepts:v - clump template original position vector or component
Arguments:cp - clump template pointer

Component Access

f = clump.template.origpos (cp)->x
clump.template.origpos (cp)->x = f

f = clump.template.origpos.x(cp)
clump.template.origpos.x(cp) = f

Get/set the \(x\)-component of the clump template original position.

Returns:f - \(x\)-component of the clump template original position vector
Accepts:f - \(x\)-component of the clump template original position vector
Arguments:cp - clump template 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.template.origpos(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.

This is hidden. Added to include remaining tensor component access functions for inline help.

f = clump.template.origpos.y(cp)
f = clump.template.origpos.z(cp) (3D ONLY)