MOM6
mom_regridding::regridding_cs Type Reference

Detailed Description

Regridding control structure.

Definition at line 40 of file MOM_regridding.F90.

Collaboration diagram for mom_regridding::regridding_cs:
[legend]

Public variables and constants

real, dimension(:), allocatable coordinateresolution
 This array is set by function setCoordinateResolution() It contains the "resolution" or delta coordinate of the target coorindate. It has the units of the target coordiante, e.g. meters for z*, non-dimensional for sigma, etc. More...
 
real, dimension(:), allocatable target_density
 This array is set by function set_target_densities() This array is the nominal coordinate of interfaces and is the running sum of coordinateResolution. i.e. target_density(k+1) = coordinateResolution(k) + coordinateResolution(k) It is only used in "rho" mode. More...
 
logical target_density_set = .false.
 
real, dimension(:), allocatable max_interface_depths
 This array is set by function set_regrid_max_depths() It specifies the maximum depth that every interface is allowed to take, in H. More...
 
real, dimension(:), allocatable max_layer_thickness
 This array is set by function set_regrid_max_thickness() It specifies the maximum depth that every interface is allowed to take, in H. More...
 
integer nk
 Number of layers/levels. More...
 
integer regridding_scheme
 Indicates which grid to use in the vertical (z*, sigma, target interface densities) More...
 
type(interp_cs_type) interp_cs
 Interpolation control structure. More...
 
real min_thickness
 Minimum thickness allowed when building the new grid through regridding. More...
 
real ref_pressure = 2.e7
 Reference pressure for potential density calculations (Pa) More...
 
real old_grid_weight = 0.
 Weight given to old coordinate when blending between new and old grids (nondim) Used only below depth_of_time_filter_shallow, with a cubic variation from zero to full effect between depth_of_time_filter_shallow and depth_of_time_filter_deep. More...
 
real depth_of_time_filter_shallow = 0.
 Depth above which no time-filtering of grid is applied (H units) More...
 
real depth_of_time_filter_deep = 0.
 Depth below which time-filtering of grid is applied at full effect (H units) More...
 
real compressibility_fraction = 0.
 Fraction (between 0 and 1) of compressibility to add to potential density profiles when interpolating for target grid positions. (nondim) More...
 
logical set_maximum_depths = .false.
 If true, each interface is given a maximum depth based on a rescaling of the indexing of coordinateResolution. More...
 
real max_depth_index_scale = 2.0
 A scaling factor (> 1) of the rate at which the coordinateResolution list is traversed to set the minimum depth of interfaces. More...
 
logical integrate_downward_for_e = .true.
 If true, integrate for interface positions from the top downward. If false, integrate from the bottom upward, as does the rest of the model. More...
 
type(zlike_cs), pointer zlike_cs => null()
 
type(sigma_cs), pointer sigma_cs => null()
 
type(rho_cs), pointer rho_cs => null()
 
type(hycom_cs), pointer hycom_cs => null()
 
type(slight_cs), pointer slight_cs => null()
 
type(adapt_cs), pointer adapt_cs => null()
 

Variables and constants

◆ adapt_cs

type(adapt_cs), pointer mom_regridding::regridding_cs::adapt_cs => null()

Definition at line 113 of file MOM_regridding.F90.

113  type(adapt_cs), pointer :: adapt_cs => null()

◆ compressibility_fraction

real mom_regridding::regridding_cs::compressibility_fraction = 0.

Fraction (between 0 and 1) of compressibility to add to potential density profiles when interpolating for target grid positions. (nondim)

Definition at line 94 of file MOM_regridding.F90.

94  real :: compressibility_fraction = 0.

◆ coordinateresolution

real, dimension(:), allocatable mom_regridding::regridding_cs::coordinateresolution

This array is set by function setCoordinateResolution() It contains the "resolution" or delta coordinate of the target coorindate. It has the units of the target coordiante, e.g. meters for z*, non-dimensional for sigma, etc.

Definition at line 47 of file MOM_regridding.F90.

47  real, dimension(:), allocatable :: coordinateresolution

◆ depth_of_time_filter_deep

real mom_regridding::regridding_cs::depth_of_time_filter_deep = 0.

Depth below which time-filtering of grid is applied at full effect (H units)

Definition at line 90 of file MOM_regridding.F90.

90  real :: depth_of_time_filter_deep = 0.

◆ depth_of_time_filter_shallow

real mom_regridding::regridding_cs::depth_of_time_filter_shallow = 0.

Depth above which no time-filtering of grid is applied (H units)

Definition at line 87 of file MOM_regridding.F90.

87  real :: depth_of_time_filter_shallow = 0.

◆ hycom_cs

type(hycom_cs), pointer mom_regridding::regridding_cs::hycom_cs => null()

Definition at line 111 of file MOM_regridding.F90.

111  type(hycom_cs), pointer :: hycom_cs => null()

◆ integrate_downward_for_e

logical mom_regridding::regridding_cs::integrate_downward_for_e = .true.

If true, integrate for interface positions from the top downward. If false, integrate from the bottom upward, as does the rest of the model.

Definition at line 106 of file MOM_regridding.F90.

106  logical :: integrate_downward_for_e = .true.

◆ interp_cs

type(interp_cs_type) mom_regridding::regridding_cs::interp_cs

Interpolation control structure.

Definition at line 72 of file MOM_regridding.F90.

72  type(interp_cs_type) :: interp_cs

◆ max_depth_index_scale

real mom_regridding::regridding_cs::max_depth_index_scale = 2.0

A scaling factor (> 1) of the rate at which the coordinateResolution list is traversed to set the minimum depth of interfaces.

Definition at line 102 of file MOM_regridding.F90.

102  real :: max_depth_index_scale = 2.0

◆ max_interface_depths

real, dimension(:), allocatable mom_regridding::regridding_cs::max_interface_depths

This array is set by function set_regrid_max_depths() It specifies the maximum depth that every interface is allowed to take, in H.

Definition at line 59 of file MOM_regridding.F90.

59  real, dimension(:), allocatable :: max_interface_depths

◆ max_layer_thickness

real, dimension(:), allocatable mom_regridding::regridding_cs::max_layer_thickness

This array is set by function set_regrid_max_thickness() It specifies the maximum depth that every interface is allowed to take, in H.

Definition at line 63 of file MOM_regridding.F90.

63  real, dimension(:), allocatable :: max_layer_thickness

◆ min_thickness

real mom_regridding::regridding_cs::min_thickness

Minimum thickness allowed when building the new grid through regridding.

Definition at line 75 of file MOM_regridding.F90.

75  real :: min_thickness

◆ nk

integer mom_regridding::regridding_cs::nk

Number of layers/levels.

Definition at line 65 of file MOM_regridding.F90.

65  integer :: nk !< Number of layers/levels

◆ old_grid_weight

real mom_regridding::regridding_cs::old_grid_weight = 0.

Weight given to old coordinate when blending between new and old grids (nondim) Used only below depth_of_time_filter_shallow, with a cubic variation from zero to full effect between depth_of_time_filter_shallow and depth_of_time_filter_deep.

Definition at line 84 of file MOM_regridding.F90.

84  real :: old_grid_weight = 0.

◆ ref_pressure

real mom_regridding::regridding_cs::ref_pressure = 2.e7

Reference pressure for potential density calculations (Pa)

Definition at line 78 of file MOM_regridding.F90.

78  real :: ref_pressure = 2.e7

◆ regridding_scheme

integer mom_regridding::regridding_cs::regridding_scheme

Indicates which grid to use in the vertical (z*, sigma, target interface densities)

Definition at line 69 of file MOM_regridding.F90.

69  integer :: regridding_scheme

◆ rho_cs

type(rho_cs), pointer mom_regridding::regridding_cs::rho_cs => null()

Definition at line 110 of file MOM_regridding.F90.

110  type(rho_cs), pointer :: rho_cs => null()

◆ set_maximum_depths

logical mom_regridding::regridding_cs::set_maximum_depths = .false.

If true, each interface is given a maximum depth based on a rescaling of the indexing of coordinateResolution.

Definition at line 98 of file MOM_regridding.F90.

98  logical :: set_maximum_depths = .false.

◆ sigma_cs

type(sigma_cs), pointer mom_regridding::regridding_cs::sigma_cs => null()

Definition at line 109 of file MOM_regridding.F90.

109  type(sigma_cs), pointer :: sigma_cs => null()

◆ slight_cs

type(slight_cs), pointer mom_regridding::regridding_cs::slight_cs => null()

Definition at line 112 of file MOM_regridding.F90.

112  type(slight_cs), pointer :: slight_cs => null()

◆ target_density

real, dimension(:), allocatable mom_regridding::regridding_cs::target_density

This array is set by function set_target_densities() This array is the nominal coordinate of interfaces and is the running sum of coordinateResolution. i.e. target_density(k+1) = coordinateResolution(k) + coordinateResolution(k) It is only used in "rho" mode.

Definition at line 54 of file MOM_regridding.F90.

54  real, dimension(:), allocatable :: target_density

◆ target_density_set

logical mom_regridding::regridding_cs::target_density_set = .false.

Definition at line 55 of file MOM_regridding.F90.

55  logical :: target_density_set = .false.

◆ zlike_cs

type(zlike_cs), pointer mom_regridding::regridding_cs::zlike_cs => null()

Definition at line 108 of file MOM_regridding.F90.

108  type(zlike_cs), pointer :: zlike_cs => null()

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