oocgcm.core.grids.VectorField3d¶
- oocgcm.core.grids.VectorField3d(vx, vy, vz, x_component_grid_location=None, y_component_grid_location=None, z_component_grid_location=None)¶
Minimal data structure for manupulating 3d vector fields on a grid.
Parameters: vx : xarray.DataArray
x-component of the vector fields
vy : xarray.DataArray
y-component of the vector fields
vz : xarray.DataArray
z-component of the vector fields
x_component_grid_location : str
string describing the grid location of the x-component
y_component_grid_location : str
string describing the grid location of the y-component
z_component_grid_location : str
string describing the grid location of the z-component
Returns: o : namedtuple
namedtuple containing the vector field.