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) [integer]

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

Return

undefined :: Enumerated integer indicating coordinate mode

Parameters

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_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_slight regridding_slight_string regridding_zstar regridding_zstar_string regridding_zstar_string_old mom_string_functions::uppercase

Called from

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 state_dependent_char

function regrid_consts/coordinateunitsi(coordMode) [character(len=16)]

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

Return

undefined :: Units of coordinate

Parameters

coordmode :: [in] Coordinate mode

Call to

mom_error_handler::mom_error regridding_adaptive regridding_hycom1 regridding_layer regridding_rho regridding_sigma regridding_sigma_shelf_zstar regridding_slight regridding_zstar

Called from

coordinateunitss

function regrid_consts/coordinateunitss(string) [character(len=16)]

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

Return

undefined :: Units of coordinate

Parameters

string :: [in] Coordinate mode

Call to

coordinatemode coordinateunitsi

function regrid_consts/state_dependent_char(string) [logical]

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

Parameters

string :: [in] String to indicate coordinate mode

Call to

coordinatemode state_dependent_int

function regrid_consts/state_dependent_int(mode) [logical]

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

Parameters

mode :: [in] Coordinate mode

Call to

mom_error_handler::mom_error regridding_adaptive regridding_hycom1 regridding_layer regridding_rho regridding_sigma regridding_sigma_shelf_zstar regridding_slight regridding_zstar

Called from

state_dependent_char