Detailed Description

Contains constants for interpreting input parameters that control regridding.

Data Types
interface	coordinateunits
	Returns a string with the coordinate units associated with the coordinate mode. More...

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

Functions/Subroutines
integer function	coordinatemode (string)
	Parse a string parameter specifying the coordinate mode and return the appropriate enumerated integer. More...

character(len=16) function	coordinateunitsi (coordMode)
	Returns a string with the coordinate units associated with the enumerated integer,. More...

character(len=16) function	coordinateunitss (string)
	Returns a string with the coordinate units associated with the string defining the coordinate mode. More...

logical function	state_dependent_char (string)
	Returns true if the coordinate is dependent on the state density, returns false otherwise. More...

logical function	state_dependent_int (mode)
	Returns true if the coordinate is dependent on the state density, returns false otherwise. More...

Variables
integer, parameter	regridding_layer = 1
	Layer mode identifier. More...

integer, parameter	regridding_zstar = 2
	z* coordinates identifier More...

integer, parameter	regridding_rho = 3
	Density coordinates identifier. More...

integer, parameter	regridding_sigma = 4
	Sigma coordinates identifier. More...

integer, parameter	regridding_arbitrary = 5
	Arbitrary coordinates identifier. More...

integer, parameter	regridding_hycom1 = 6
	Simple HyCOM coordinates without BBL. More...

integer, parameter	regridding_slight = 7
	Identifier for stretched coordinates in the lightest water, isopycnal below. More...

integer, parameter	regridding_sigma_shelf_zstar = 8
	Identifiered for z* coordinates at the bottom, sigma-near the top. More...

integer, parameter	regridding_adaptive = 9
	Adaptive coordinate mode identifier. More...

character(len= *), parameter	regridding_layer_string = "LAYER"
	Layer string. More...

character(len= *), parameter	regridding_zstar_string_old = "Z*"
	z* string (legacy name) More...

character(len= *), parameter	regridding_zstar_string = "ZSTAR"
	z* string More...

character(len= *), parameter	regridding_rho_string = "RHO"
	Rho string. More...

character(len= *), parameter	regridding_sigma_string = "SIGMA"
	Sigma string. More...

character(len= *), parameter	regridding_arbitrary_string = "ARB"
	Arbitrary coordinates. More...

character(len= *), parameter	regridding_hycom1_string = "HYCOM1"
	Hycom string. More...

character(len= *), parameter	regridding_slight_string = "SLIGHT"
	Hybrid S-rho string. More...

character(len= *), parameter	regridding_sigma_shelf_zstar_string = "SIGMA_SHELF_ZSTAR"
	Hybrid z*/sigma. More...

character(len= *), parameter	regridding_adaptive_string = "ADAPTIVE"
	Adaptive coordinate string. More...

character(len= *), parameter	default_coordinate_mode = REGRIDDING_LAYER_STRING
	Default coordinate mode. More...

Function/Subroutine Documentation

◆ coordinatemode()

integer function regrid_consts::coordinatemode ( character(len=*), intent(in) string )

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

Returns: Enumerated integer indicating coordinate mode

Parameters

[in] string String to indicate coordinate mode

Definition at line 54 of file regrid_consts.F90.

   integer :: coordinateMode !< Enumerated integer indicating coordinate mode
   character(len=*), intent(in) :: string !< String to indicate coordinate mode
   select case ( uppercase(trim(string)) )
     case (trim(regridding_layer_string)); coordinatemode = regridding_layer
     case (trim(regridding_zstar_string)); coordinatemode = regridding_zstar
     case (trim(regridding_zstar_string_old)); coordinatemode = regridding_zstar
     case (trim(regridding_rho_string));   coordinatemode = regridding_rho
     case (trim(regridding_sigma_string)); coordinatemode = regridding_sigma
     case (trim(regridding_hycom1_string)); coordinatemode = regridding_hycom1
     case (trim(regridding_slight_string)); coordinatemode = regridding_slight
     case (trim(regridding_arbitrary_string)); coordinatemode = regridding_arbitrary
     case (trim(regridding_sigma_shelf_zstar_string)); coordinatemode = regridding_sigma_shelf_zstar
     case (trim(regridding_adaptive_string)); coordinatemode = regridding_adaptive
     case default ; call mom_error(fatal, "coordinateMode: "//&
        "Unrecognized choice of coordinate ("//trim(string)//").")
   end select

References 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, and mom_string_functions::uppercase().

Referenced by 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(), and state_dependent_char().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coordinateunitsi()

character(len=16) function regrid_consts::coordinateunitsi ( integer, intent(in) coordMode )

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

Returns: Units of coordinate

Parameters

[in] coordmode Coordinate mode

Definition at line 75 of file regrid_consts.F90.

   character(len=16) :: coordinateUnitsI !< Units of coordinate
   integer, intent(in) :: coordMode !< Coordinate mode
   select case ( coordmode )
     case (regridding_layer); coordinateunitsi = "kg m^-3"
     case (regridding_zstar); coordinateunitsi = "m"
     case (regridding_sigma_shelf_zstar); coordinateunitsi = "m"
     case (regridding_rho);   coordinateunitsi = "kg m^-3"
     case (regridding_sigma); coordinateunitsi = "Non-dimensional"
     case (regridding_hycom1); coordinateunitsi = "m"
     case (regridding_slight); coordinateunitsi = "m"
     case (regridding_adaptive); coordinateunitsi = "m"
     case default ; call mom_error(fatal, "coordinateUnts: "//&
        "Unrecognized coordinate mode.")
   end select

References mom_error_handler::mom_error(), regridding_adaptive, regridding_hycom1, regridding_layer, regridding_rho, regridding_sigma, regridding_sigma_shelf_zstar, regridding_slight, and regridding_zstar.

Referenced by coordinateunitss().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coordinateunitss()

character(len=16) function regrid_consts::coordinateunitss ( character(len=*), intent(in) string )

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

Returns: Units of coordinate

Parameters

[in] string Coordinate mode

Definition at line 94 of file regrid_consts.F90.

   character(len=16) :: coordinateUnitsS !< Units of coordinate
   character(len=*), intent(in) :: string !< Coordinate mode
   integer :: coordMode
   coordmode = coordinatemode(string)
   coordinateunitss = coordinateunitsi(coordmode)

References coordinatemode(), and coordinateunitsi().

Here is the call graph for this function:

◆ state_dependent_char()

logical function regrid_consts::state_dependent_char ( character(len=*), intent(in) string )

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

Parameters

[in] string String to indicate coordinate mode

Definition at line 103 of file regrid_consts.F90.

   character(len=*), intent(in) :: string !< String to indicate coordinate mode
  
   state_dependent_char = state_dependent_int( coordinatemode(string) )

References coordinatemode(), and state_dependent_int().

Here is the call graph for this function:

◆ state_dependent_int()

logical function regrid_consts::state_dependent_int ( integer, intent(in) mode )

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

Parameters

[in] mode Coordinate mode

Definition at line 111 of file regrid_consts.F90.

   integer, intent(in) :: mode !< Coordinate mode
   select case ( mode )
     case (regridding_layer); state_dependent_int = .true.
     case (regridding_zstar); state_dependent_int = .false.
     case (regridding_sigma_shelf_zstar); state_dependent_int = .false.
     case (regridding_rho);   state_dependent_int = .true.
     case (regridding_sigma); state_dependent_int = .false.
     case (regridding_hycom1); state_dependent_int = .true.
     case (regridding_slight); state_dependent_int = .true.
     case (regridding_adaptive); state_dependent_int = .true.
     case default ; call mom_error(fatal, "state_dependent: "//&
        "Unrecognized choice of coordinate.")
   end select

References mom_error_handler::mom_error(), regridding_adaptive, regridding_hycom1, regridding_layer, regridding_rho, regridding_sigma, regridding_sigma_shelf_zstar, regridding_slight, and regridding_zstar.

Referenced by state_dependent_char().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ default_coordinate_mode

character(len=*), parameter regrid_consts::default_coordinate_mode = REGRIDDING_LAYER_STRING

Default coordinate mode.

Definition at line 35 of file regrid_consts.F90.

35 character(len=*), parameter :: DEFAULT_COORDINATE_MODE = REGRIDDING_LAYER_STRING !< Default coordinate mode

◆ regridding_adaptive

integer, parameter regrid_consts::regridding_adaptive = 9

Adaptive coordinate mode identifier.

Definition at line 23 of file regrid_consts.F90.

23 integer, parameter :: REGRIDDING_ADAPTIVE = 9 !< Adaptive coordinate mode identifier

Referenced by coordinatemode(), coordinateunitsi(), mom_regridding::getcoordinateshortname(), mom_regridding::getcoordinateunits(), mom_regridding::getstaticthickness(), mom_regridding::initcoord(), mom_regridding::initialize_regridding(), mom_regridding::regridding_main(), mom_regridding::set_regrid_params(), state_dependent_int(), and mom_regridding::uniformresolution().

◆ regridding_adaptive_string

character(len=*), parameter regrid_consts::regridding_adaptive_string = "ADAPTIVE"

Adaptive coordinate string.

Definition at line 34 of file regrid_consts.F90.

34 character(len=*), parameter :: REGRIDDING_ADAPTIVE_STRING = "ADAPTIVE" !< Adaptive coordinate string

Referenced by coordinatemode().

◆ regridding_arbitrary

integer, parameter regrid_consts::regridding_arbitrary = 5

Arbitrary coordinates identifier.

Definition at line 17 of file regrid_consts.F90.

17 integer, parameter :: REGRIDDING_ARBITRARY = 5 !< Arbitrary coordinates identifier

Referenced by coordinatemode().

◆ regridding_arbitrary_string

character(len=*), parameter regrid_consts::regridding_arbitrary_string = "ARB"

Arbitrary coordinates.

Definition at line 30 of file regrid_consts.F90.

30 character(len=*), parameter :: REGRIDDING_ARBITRARY_STRING = "ARB" !< Arbitrary coordinates

Referenced by coordinatemode().

◆ regridding_hycom1

integer, parameter regrid_consts::regridding_hycom1 = 6

Simple HyCOM coordinates without BBL.

Definition at line 18 of file regrid_consts.F90.

18 integer, parameter :: REGRIDDING_HYCOM1 = 6 !< Simple HyCOM coordinates without BBL

Referenced by coordinatemode(), coordinateunitsi(), mom_regridding::getcoordinateshortname(), mom_regridding::getcoordinateunits(), mom_regridding::getstaticthickness(), mom_regridding::initcoord(), mom_regridding::initialize_regridding(), mom_regridding::regridding_main(), mom_regridding::set_regrid_max_depths(), mom_regridding::set_regrid_max_thickness(), mom_regridding::set_regrid_params(), state_dependent_int(), and mom_regridding::uniformresolution().

◆ regridding_hycom1_string

character(len=*), parameter regrid_consts::regridding_hycom1_string = "HYCOM1"

Hycom string.

Definition at line 31 of file regrid_consts.F90.

31 character(len=*), parameter :: REGRIDDING_HYCOM1_STRING = "HYCOM1" !< Hycom string

Referenced by coordinatemode().

◆ regridding_layer

integer, parameter regrid_consts::regridding_layer = 1

Layer mode identifier.

Definition at line 13 of file regrid_consts.F90.

13 integer, parameter :: REGRIDDING_LAYER = 1 !< Layer mode identifier

Referenced by coordinatemode(), coordinateunitsi(), and state_dependent_int().

◆ regridding_layer_string

character(len=*), parameter regrid_consts::regridding_layer_string = "LAYER"

Layer string.

Definition at line 25 of file regrid_consts.F90.

25 character(len=*), parameter :: REGRIDDING_LAYER_STRING = "LAYER" !< Layer string

Referenced by coordinatemode().

◆ regridding_rho

integer, parameter regrid_consts::regridding_rho = 3

Density coordinates identifier.

Definition at line 15 of file regrid_consts.F90.

15 integer, parameter :: REGRIDDING_RHO = 3 !< Density coordinates identifier

Referenced by adjustment_initialization::adjustment_initialize_temperature_salinity(), adjustment_initialization::adjustment_initialize_thickness(), coordinatemode(), coordinateunitsi(), dome2d_initialization::dome2d_initialize_temperature_salinity(), dome2d_initialization::dome2d_initialize_thickness(), dumbbell_initialization::dumbbell_initialize_thickness(), rossby_front_2d_initialization::rossby_front_initialize_thickness(), seamount_initialization::seamount_initialize_temperature_salinity(), seamount_initialization::seamount_initialize_thickness(), and state_dependent_int().

◆ regridding_rho_string

character(len=*), parameter regrid_consts::regridding_rho_string = "RHO"

Rho string.

Definition at line 28 of file regrid_consts.F90.

28 character(len=*), parameter :: REGRIDDING_RHO_STRING = "RHO" !< Rho string

Referenced by coordinatemode().

◆ regridding_sigma

integer, parameter regrid_consts::regridding_sigma = 4

Sigma coordinates identifier.

Definition at line 16 of file regrid_consts.F90.

16 integer, parameter :: REGRIDDING_SIGMA = 4 !< Sigma coordinates identifier

Referenced by adjustment_initialization::adjustment_initialize_temperature_salinity(), adjustment_initialization::adjustment_initialize_thickness(), coordinatemode(), coordinateunitsi(), dome2d_initialization::dome2d_initialize_temperature_salinity(), dome2d_initialization::dome2d_initialize_thickness(), dumbbell_initialization::dumbbell_initialize_thickness(), rossby_front_2d_initialization::rossby_front_initialize_thickness(), seamount_initialization::seamount_initialize_temperature_salinity(), seamount_initialization::seamount_initialize_thickness(), and state_dependent_int().

◆ regridding_sigma_shelf_zstar

integer, parameter regrid_consts::regridding_sigma_shelf_zstar = 8

Identifiered for z* coordinates at the bottom, sigma-near the top.

Definition at line 21 of file regrid_consts.F90.

21 integer, parameter :: REGRIDDING_SIGMA_SHELF_ZSTAR = 8 !< Identifiered for z* coordinates at the bottom,

Referenced by coordinatemode(), coordinateunitsi(), isomip_initialization::isomip_initialize_sponges(), isomip_initialization::isomip_initialize_temperature_salinity(), isomip_initialization::isomip_initialize_thickness(), and state_dependent_int().

◆ regridding_sigma_shelf_zstar_string

character(len=*), parameter regrid_consts::regridding_sigma_shelf_zstar_string = "SIGMA_SHELF_ZSTAR"

Hybrid z*/sigma.

Definition at line 33 of file regrid_consts.F90.

33 character(len=*), parameter :: REGRIDDING_SIGMA_SHELF_ZSTAR_STRING = "SIGMA_SHELF_ZSTAR" !< Hybrid z*/sigma

Referenced by coordinatemode().

◆ regridding_sigma_string

character(len=*), parameter regrid_consts::regridding_sigma_string = "SIGMA"

Sigma string.

Definition at line 29 of file regrid_consts.F90.

29 character(len=*), parameter :: REGRIDDING_SIGMA_STRING = "SIGMA" !< Sigma string

Referenced by coordinatemode().

◆ regridding_slight

integer, parameter regrid_consts::regridding_slight = 7

Identifier for stretched coordinates in the lightest water, isopycnal below.

Definition at line 19 of file regrid_consts.F90.

19 integer, parameter :: REGRIDDING_SLIGHT = 7 !< Identifier for stretched coordinates in the

Referenced by coordinatemode(), coordinateunitsi(), mom_regridding::getcoordinateshortname(), mom_regridding::getcoordinateunits(), mom_regridding::getstaticthickness(), mom_regridding::initcoord(), mom_regridding::initialize_regridding(), mom_regridding::regridding_main(), mom_regridding::set_regrid_max_depths(), mom_regridding::set_regrid_max_thickness(), mom_regridding::set_regrid_params(), state_dependent_int(), and mom_regridding::uniformresolution().

◆ regridding_slight_string

character(len=*), parameter regrid_consts::regridding_slight_string = "SLIGHT"

Hybrid S-rho string.

Definition at line 32 of file regrid_consts.F90.

32 character(len=*), parameter :: REGRIDDING_SLIGHT_STRING = "SLIGHT" !< Hybrid S-rho string

Referenced by coordinatemode().

◆ regridding_zstar

integer, parameter regrid_consts::regridding_zstar = 2

z* coordinates identifier

Definition at line 14 of file regrid_consts.F90.

14 integer, parameter :: REGRIDDING_ZSTAR = 2 !< z* coordinates identifier

Referenced by coordinatemode(), coordinateunitsi(), and state_dependent_int().

◆ regridding_zstar_string

character(len=*), parameter regrid_consts::regridding_zstar_string = "ZSTAR"

z* string

Definition at line 27 of file regrid_consts.F90.

27 character(len=*), parameter :: REGRIDDING_ZSTAR_STRING = "ZSTAR" !< z* string

Referenced by coordinatemode().

◆ regridding_zstar_string_old

character(len=*), parameter regrid_consts::regridding_zstar_string_old = "Z*"

z* string (legacy name)

Definition at line 26 of file regrid_consts.F90.

26 character(len=*), parameter :: REGRIDDING_ZSTAR_STRING_OLD = "Z*" !< z* string (legacy name)

Referenced by coordinatemode().

Detailed Description

Data Types

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ coordinatemode()

◆ coordinateunitsi()

◆ coordinateunitss()

◆ state_dependent_char()

◆ state_dependent_int()

Variable Documentation

◆ default_coordinate_mode

◆ 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