MOM6
regrid_consts::state_dependent Interface Reference

Detailed Description

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

Definition at line 44 of file regrid_consts.F90.

Public functions

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

Detailed Description

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

Definition at line 44 of file regrid_consts.F90.

Functions and subroutines

◆ state_dependent_char()

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

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

Parameters
[in]stringString to indicate coordinate mode

Definition at line 102 of file regrid_consts.F90.

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

◆ state_dependent_int()

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

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

Parameters
[in]modeCoordinate mode

Definition at line 110 of file regrid_consts.F90.

111  integer, intent(in) :: mode !< Coordinate mode
112  select case ( mode )
113  case (regridding_layer); state_dependent_int = .true.
114  case (regridding_zstar); state_dependent_int = .false.
115  case (regridding_sigma_shelf_zstar); state_dependent_int = .false.
116  case (regridding_rho); state_dependent_int = .true.
117  case (regridding_sigma); state_dependent_int = .false.
118  case (regridding_hycom1); state_dependent_int = .true.
119  case (regridding_slight); state_dependent_int = .true.
120  case (regridding_adaptive); state_dependent_int = .true.
121  case default ; call mom_error(fatal, "state_dependent: "//&
122  "Unrecognized choice of coordinate.")
123  end select

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