gp.force.unbal

Syntax

v := gp.force.unbal(gp)

Get the unbalanced force at a gridpoint after the last cycle.

Note that unlike versions of FLAC prior to 7.0, this version returns the net unbalanced force after the last step. This includes all sources, including forces due to gravity and applied conditions. This value is not updated during a cycle to reflect the current unbalanced force.

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

Returns:

v - last unbalanced force vector

Arguments:

gp - a zone gridpoint pointer

Component Access

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

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

Get the \(x\)-component of the unbalanced force at a gridpoint after the last cycle.

Returns:

f - \(x\)-component of the last unbalanced force vector

Arguments:

gp - a zone gridpoint 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 (gp.force.unbal(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.y(gp)

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