gp.force.unbal

Syntax

Vector Access

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

Get/set the unbalanced force at a gridpoint. This includes all sources, including forces due to gravity. Returns a vector, unless an optional component argument i is supplied, in which case it returns the component value.

Returns:

v - unbalanced force vector or component
Arguments:

gp - gridpoint pointer

i - optional vector component, from 1 to 3

Component Access

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

Get/set the x-component unbalanced force vector.

Returns:f - x-component unbalanced force vector
Arguments:gp - gridpoint pointer
f = gp.force.unbal.y(gp)
gp.force.unbal.y(gp) = f

Get/set the y-component unbalanced force vector.

Returns:f - y-component unbalanced force vector
Arguments:gp - gridpoint pointer
f = gp.force.unbal.z(gp)
gp.force.unbal.z(gp) = f

Get/set the z-component unbalanced force vector.

Returns:f - z-component unbalanced force vector
Arguments:gp - gridpoint pointer