gp.mass.add
Syntax
- v := gp.mass.add(gp)
- gp.mass.add(gp) := v
Get/set the added mass vector for the gridpoint. This mass is added to the inertial mass of the gridpoint during equations of motion.
Returns: v - added mass vector
Accepts: v - added mass vector
Arguments: z - zone pointer
Component Access
f := gp.mass.add
(gp)->x
gp.mass.add
(gp)->x
:= f
- f := gp.mass.add.x(gp)
- gp.mass.add.x(gp) := f
Get/set the \(x\)-component of the added mass vector for the gridpoint.
Returns: f - \(x\)-component of the added mass vector Accepts: f - \(x\)-component of the added mass vector Arguments: gp - zone pointer
Access other vector components (\(y\), \(z\)) 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 (gp.mass.add(gp,<int>)
) 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 |