gp.mass.add

Syntax

Vector Access

v = gp.mass.add(gp<,i>)

gp.mass.add(gp<,i>) = v

Get/set the added mass vector for the gridpoint. This mass is added to the inertial mass of the gridpoint during equations of motion. Returns a vector, unless an optional component argument i is supplied, in which case it returns the component value.

Returns:

v - added mass vector or component

Accepts:

v - added mass vector or component

Arguments:

gp - gridpoint pointer

i - optional vector component, from 1 to 3

Component Access

f = gp.mass.add.x(gp)

gp.mass.add.x(gp) = f

Get/set the x-component added mass vector.

Returns:f - x-component added mass vector Accepts:f - x-component added mass vector Arguments:gp - gridpoint pointer

f = gp.mass.add.y(gp)

gp.mass.add.y(gp) = f

Get/set the y-component added mass vector.

Returns:f - y-component added mass vector Accepts:f - y-component added mass vector Arguments:gp - gridpoint pointer

f = gp.mass.add.z(gp)

gp.mass.add.z(gp) = f

Get/set the z-component added mass vector.

Returns:f - z-component added mass vector Accepts:f - z-component added mass vector Arguments:gp - gridpoint pointer