regrid_consts module reference

Contains constants for interpreting input parameters that control regridding.

More…

Functions/Subroutines

coordinatemode()	Parse a string parameter specifying the coordinate mode and return the appropriate enumerated integer.
coordinateunitsi()	Returns a string with the coordinate units associated with the enumerated integer,.
coordinateunitss()	Returns a string with the coordinate units associated with the string defining the coordinate mode.
state_dependent_char()	Returns true if the coordinate is dependent on the state density, returns false otherwise.
state_dependent_int()	Returns true if the coordinate is dependent on the state density, returns false otherwise.

Detailed Description

Contains constants for interpreting input parameters that control regridding.

Function/Subroutine Documentation

function  regrid_consts/coordinatemode(string)

Parse a string parameter specifying the coordinate mode and return the appropriate enumerated integer.

Return:

undefined :: Enumerated integer indicating coordinate mode

Parameters:

string :: string [in] String to indicate coordinate mode

Call to:

mom_error_handler::mom_error regridding_adaptive regridding_adaptive_string regridding_arbitrary regridding_arbitrary_string regridding_hybgen regridding_hybgen_string regridding_hycom1 regridding_hycom1_string regridding_layer regridding_layer_string regridding_rho regridding_rho_string regridding_sigma regridding_sigma_shelf_zstar regridding_sigma_shelf_zstar_string regridding_sigma_string regridding_zstar regridding_zstar_string regridding_zstar_string_old mom_string_functions::uppercase

Called from:

regrid_consts::coordinateunits::coordinateunitss mom_diag_remap::diag_remap_calc_hmask mom_diag_remap::diag_remap_configure_axes mom_diag_remap::diag_remap_init mom_diag_remap::diag_remap_update regrid_consts::state_dependent::state_dependent_char

[source]

function  regrid_consts/coordinateunitsi(coordMode)

Returns a string with the coordinate units associated with the enumerated integer,.

Return:

undefined :: Units of coordinate

Parameters:

coordmode :: [in] Coordinate mode

Called from:

regrid_consts::coordinateunits::coordinateunitsi regrid_consts::coordinateunits::coordinateunitss

[source]

function  regrid_consts/coordinateunitss(string)

Returns a string with the coordinate units associated with the string defining the coordinate mode.

Return:

undefined :: Units of coordinate

Parameters:

string :: string [in] Coordinate mode

Called from:

regrid_consts::coordinateunits::coordinateunitss

[source]

function  regrid_consts/state_dependent_char(string)

Returns true if the coordinate is dependent on the state density, returns false otherwise.

Parameters:

string :: string [in] String to indicate coordinate mode

Called from:

regrid_consts::state_dependent::state_dependent_char

[source]

function  regrid_consts/state_dependent_int(mode)

Returns true if the coordinate is dependent on the state density, returns false otherwise.

Parameters:

mode :: mode [in] Coordinate mode

Called from:

regrid_consts::state_dependent::state_dependent_char regrid_consts::state_dependent::state_dependent_int

[source]

[source]