MOM6
regrid_consts::coordinateunits Interface Reference

Detailed Description

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

Definition at line 38 of file regrid_consts.F90.

Public functions

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...
 

Functions and subroutines

◆ coordinateunitsi()

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

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

Returns
Units of coordinate
Parameters
[in]coordmodeCoordinate mode

Definition at line 75 of file regrid_consts.F90.

75  character(len=16) :: coordinateUnitsI !< Units of coordinate
76  integer, intent(in) :: coordMode !< Coordinate mode
77  select case ( coordmode )
78  case (regridding_layer); coordinateunitsi = "kg m^-3"
79  case (regridding_zstar); coordinateunitsi = "m"
80  case (regridding_sigma_shelf_zstar); coordinateunitsi = "m"
81  case (regridding_rho); coordinateunitsi = "kg m^-3"
82  case (regridding_sigma); coordinateunitsi = "Non-dimensional"
83  case (regridding_hycom1); coordinateunitsi = "m"
84  case (regridding_slight); coordinateunitsi = "m"
85  case (regridding_adaptive); coordinateunitsi = "m"
86  case default ; call mom_error(fatal, "coordinateUnts: "//&
87  "Unrecognized coordinate mode.")
88  end select

◆ coordinateunitss()

character(len=16) function regrid_consts::coordinateunits::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]stringCoordinate mode

Definition at line 94 of file regrid_consts.F90.

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

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