namespace regrid_consts

Overview

Contains constants for interpreting input parameters that control regridding. More…

namespace regrid_consts {

// interfaces

interface coordinateunits;
interface state_dependent;

// global variables

integer, parameter regridding_layer = 1;
integer, parameter regridding_zstar = 2;
integer, parameter regridding_rho = 3;
integer, parameter regridding_sigma = 4;
integer, parameter regridding_arbitrary = 5;
integer, parameter regridding_hycom1 = 6;
integer, parameter regridding_slight = 7;
integer, parameter regridding_sigma_shelf_zstar = 8;
integer, parameter regridding_adaptive = 9;
character(len=*), parameter regridding_layer_string = "LAYER";
character(len=*), parameter regridding_zstar_string_old = "Z*";
character(len=*), parameter regridding_zstar_string = "ZSTAR";
character(len=*), parameter regridding_rho_string = "RHO";
character(len=*), parameter regridding_sigma_string = "SIGMA";
character(len=*), parameter regridding_arbitrary_string = "ARB";
character(len=*), parameter regridding_hycom1_string = "HYCOM1";
character(len=*), parameter regridding_slight_string = "SLIGHT";
character(len=*), parameter regridding_sigma_shelf_zstar_string = "SIGMA_SHELF_ZSTAR";
character(len=*), parameter regridding_adaptive_string = "ADAPTIVE";
character(len=*), parameter default_coordinate_mode = REGRIDDING_LAYER_STRING;

// global functions

integer function coordinatemode(string string);
character(len=16) function coordinateunitsi(coordMode coordMode);
character(len=16) function coordinateunitss(string string);
logical function state_dependent_char(string string);
logical function state_dependent_int(mode mode);

} // namespace regrid_consts

Detailed Documentation

Contains constants for interpreting input parameters that control regridding.

Global Variables

integer, parameter regridding_layer = 1

Layer mode identifier.

integer, parameter regridding_zstar = 2

z* coordinates identifier

integer, parameter regridding_rho = 3

Density coordinates identifier.

integer, parameter regridding_sigma = 4

Sigma coordinates identifier.

integer, parameter regridding_arbitrary = 5

Arbitrary coordinates identifier.

integer, parameter regridding_hycom1 = 6

Simple HyCOM coordinates without BBL.

integer, parameter regridding_slight = 7

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

integer, parameter regridding_sigma_shelf_zstar = 8

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

integer, parameter regridding_adaptive = 9

Adaptive coordinate mode identifier.

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

Layer string.

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

z* string (legacy name)

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

z* string

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

Rho string.

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

Sigma string.

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

Arbitrary coordinates.

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

Hycom string.

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

Hybrid S-rho string.

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

Hybrid z*/sigma.

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

Adaptive coordinate string.

character(len=*), parameter default_coordinate_mode = REGRIDDING_LAYER_STRING

Default coordinate mode.

Global Functions

integer function coordinatemode(string string)

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

Parameters:

string

String to indicate coordinate mode

Returns:

Enumerated integer indicating coordinate mode

character(len=16) function coordinateunitsi(coordMode coordMode)

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

Parameters:

coordmode

Coordinate mode

Returns:

Units of coordinate

character(len=16) function coordinateunitss(string string)

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

Parameters:

string

Coordinate mode

Returns:

Units of coordinate

logical function state_dependent_char(string string)

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

Parameters:

string

String to indicate coordinate mode

logical function state_dependent_int(mode mode)

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

Parameters:

mode	Coordinate mode