gp.force.unbal.current

Syntax

v := gp.force.unbal.current(gp)

Get the current unbalanced force at a gridpoint.

This returns the unbalanced force current value as it is accumulated during cycling. At the end of cycling, this value is cleared to zero. This value does not include forces due to gravity and applied conditions.

See also the FISH intrinsics gp.force.unbal and gp.force.unbal.add.

Returns:v - current unbalanced force vector
Arguments:gp - grid point pointer

Component Access

f := gp.force.unbal.current (gp)->x

f := gp.force.unbal.current.x(gp)

Get the \(x\)-component of the current unbalanced force at a gridpoint.

Returns:f - \(x\)-component of the current unbalanced force vector
Arguments:gp - grid point 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.force.unbal.current(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.

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

f := gp.force.unbal.current.y(gp)
f := gp.force.unbal.current.z(gp)