mitgcm
Analysis of MITgcm output using python
|
This is the class for all fields on meridional velocity points. More...
Public Member Functions | |
def | __init__ |
Instantiate a field on the meridional velocity points. More... | |
def | load_field |
Load a model field from NetCDF output. More... | |
def | take_d_dx |
Take the x derivative of the field on v points using the spacings in model_instance.grid object. More... | |
def | take_d_dy |
Take the y derivative of the field given on v-points, using the spacings in grid object. More... | |
def | take_d_dz |
Take the z derivative of the field given on v-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 | |
This is the class for all fields on meridional velocity points.
def mitgcm.core.Vpoint_field.__init__ | ( | self, | |
model_instance, | |||
netcdf_filename, | |||
variable, | |||
time_level = -1 , |
|||
empty = False , |
|||
field_name = None , |
|||
single_file = False |
|||
) |
def mitgcm.core.Vpoint_field.load_field | ( | self, | |
model_instance, | |||
netcdf_filename, | |||
variable, | |||
time_level = -1 , |
|||
field_name = None , |
|||
grid_loc = 'V' , |
|||
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.
netcdf_filename can be a string with shell wildcards - they'll be expanded and all of the files loaded. BUT, this is intended as a way to take a quick look at the model. I would strongly recommend using something like "gluemncbig" to join the multiple tiles into one file before doing proper analysis.
def mitgcm.core.Vpoint_field.shift_to_tracer | ( | self, | |
field_name | |||
) |
def mitgcm.core.Vpoint_field.take_d_dx | ( | self, | |
model_instance, | |||
input_field = 'VVEL' , |
|||
output_field = 'dV_dx' |
|||
) |
Take the x derivative of the field on v points using the spacings in model_instance.grid object.
This function can be daisy-chained to get higher order derivatives.
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).
def mitgcm.core.Vpoint_field.take_d_dy | ( | self, | |
model_instance, | |||
input_field = 'VVEL' , |
|||
output_field = 'dV_dy' |
|||
) |
Take the y derivative of the field given on v-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).
def mitgcm.core.Vpoint_field.take_d_dz | ( | self, | |
model_instance, | |||
input_field = 'VVEL' , |
|||
output_field = 'dV_dz' |
|||
) |
Take the z derivative of the field given on v-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).