gp.force.unbal.current

Syntax

Vector Access

v := gp.force.unbal.current(gp<,i>)

Get the current unbalanced force at a gridpoint. Returns a vector, unless an optional component argument i is supplied, in which case it returns the component value.

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 or component

Arguments:

gp - grid point pointer

i - optional vector component, from 1 to 3