gp.force.load

Syntax

Vector Access

v := gp.force.load(gp<,i>)
gp.force.load(gp<,i>) := 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).

Returns:

v - FISH applied force vector or component

Accepts:

v - FISH applied force vector or component

Arguments:

z - zone pointer

i - optional vector component, from 1 to 3

Component Access

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

Get the \(x\)-component FISH applied force vector.

Returns:f - \(x\)-component FISH applied force vector
Accepts:f - \(x\)-component FISH applied force vector
Arguments:z - zone pointer
f := gp.force.load.y(gp)
gp.force.load.y(gp) := f

Get the \(y\)-component FISH applied force vector.

Returns:f - \(y\)-component FISH applied force vector
Accepts:f - \(y\)-component FISH applied force vector
Arguments:z - zone pointer
f := gp.force.load.z(gp)
gp.force.load.z(gp) := f

Get the \(z\)-component FISH applied force vector.

Returns:f - \(z\)-component FISH applied force vector
Accepts:f - \(z\)-component FISH applied force vector
Arguments:z - zone pointer