mitgcm.core.Wpoint_field Class Reference

This is the class for all fields on vertical velocity points. More...

Inheritance diagram for mitgcm.core.Wpoint_field:

Public Member Functions
def	__init__
def	load_field
	Load a model field from NetCDF output. More...
def	take_d_dx
	Take the x derivative of the field on w points, using spacings in grid object. More...
def	take_d_dy
	Take the y derivative of the field on w points, using spacings in grid object. More...
def	take_d_dz
	Take the z derivative of the field given on w-points, using the spacings in grid object. More...
def	shift_to_tracer (self, field_name)
	Shift the array on to the corresponding tracer point. More...
Public Member Functions inherited from mitgcm.core.MITgcm_Simulation
def	__init__
	Instantiate an MITgcm model instance. More...
def	load_field
	Load a model field from NetCDF output. More...
def	load_from_file (self, model_instance, file_list, variable, time_level, grid_loc, single_file)
	Internal function to pull the data from the file(s). More...
def	__add__ (self, other)
	A method that allows model objects to be added together. More...
def	__div__ (self, other)
	A method that allows model objects to be divided by floating point numbers. More...
def	__mul__ (self, other)
	A method that allows model objects to be multiplied by floating point numbers. More...
def	__rmul__ (self, other)
	A method that allows model objects to be multiplied by floating point numbers. More...

Additional Inherited Members
Public Attributes inherited from mitgcm.core.MITgcm_Simulation
	grid

Detailed Description

This is the class for all fields on vertical velocity points.

Definition at line 459 of file core.py.

Constructor & Destructor Documentation

def mitgcm.core.Wpoint_field.__init__	(		self,
			model_instance,
			netcdf_filename,
			variable,
			time_level = -1,
			empty = False,
			field_name = None,
			single_file = False
	)

Definition at line 462 of file core.py.

Member Function Documentation

def mitgcm.core.Wpoint_field.load_field	(		self,
			model_instance,
			netcdf_filename,
			variable,
			time_level = -1,
			field_name = None,
			grid_loc = 'W',
			single_file = False
	)

Load a model field from NetCDF output.

This function associates the field with the object it is called on.

time_level can be an integer or an array of integers. If it's an array, then multiple time levels will be returned as a higher dimensional array.

Definition at line 470 of file core.py.

def mitgcm.core.Wpoint_field.shift_to_tracer	(		self,
			field_name
	)

Shift the array on to the corresponding tracer point.

Definition at line 587 of file core.py.

def mitgcm.core.Wpoint_field.take_d_dx	(		self,
			model_instance,
			input_field = 'WVEL',
			output_field = 'dW_dx'
	)

Take the x derivative of the field on w points, using spacings in grid object.

Performs centred second-order differencing everywhere except next to boundaries. First order is used there (meaning the gradients at the boundary are evaluated half a grid point away from where they should be).

Definition at line 493 of file core.py.

def mitgcm.core.Wpoint_field.take_d_dy	(		self,
			model_instance,
			input_field = 'WVEL',
			output_field = 'dW_dy'
	)

Take the y derivative of the field on w points, using spacings in grid object.

Performs centred second-order differencing everywhere except next to boundaries. First order is used there (meaning the gradients at the boundary are evaluated half a grid point away from where they should be).

Definition at line 525 of file core.py.

def mitgcm.core.Wpoint_field.take_d_dz	(		self,
			model_instance,
			input_field = 'WVEL',
			output_field = 'dW_dz'
	)

Take the z derivative of the field given on w-points, using the spacings in grid object.

Performs centred second-order differencing everywhere except next to boundaries. First order is used there (meaning the gradients at the boundary are evaluated half a grid point away from where they should be).

Definition at line 556 of file core.py.

---

The documentation for this class was generated from the following file:

• core.py