gp.force.load

Syntax

v := gp.force.load(gp)

gp.force.load(gp) := v

Get/set the FISH applied force at a gridpoint. This force is kept separate from forces applied due to zone face apply (for example). The default value is (0,0,0) in 3D and (0,0) in 2D.

Returns:

v - FISH applied force vector

Accepts:

v - FISH applied force vector

Arguments:

gp - a zone gridpoint pointer

Component Access

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

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

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

Get/set the \(x\)-component of the FISH applied force at a gridpoint.

Returns:

f - \(x\)-component of the FISH applied force vector

Accepts:

f - \(x\)-component of the FISH applied 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.load(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.load.y(gp)

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