MOM6
mom_regridding::regridding_cs Type Reference

Detailed Description

Regridding control structure.

Definition at line 45 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 coordinate. It has the units of the target coordinate, e.g. [Z ~> m] for z*, non-dimensional for sigma, etc. More...
 
real coord_scale = 1.0
 This is a scaling factor that restores coordinateResolution to values in the natural units for output. 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, in [R ~> kg m-3]. i.e. target_density(k+1) = coordinateResolution(k) + coordinateResolution(k) It is only used in "rho", "SLight" or "Hycom" mode. More...
 
logical target_density_set = .false.
 A flag to indicate that the target_density arrays has been filled with data. More...
 
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 [H ~> m or kg m-2]. 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 [H ~> m or kg m-2]. More...
 
integer nk
 Number of layers/levels in generated grid. 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 [H ~> m or kg m-2]. 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 ~> m or kg m-2]. More...
 
real depth_of_time_filter_deep = 0.
 Depth below which time-filtering of grid is applied at full effect [H ~> m or kg m-2]. 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()
 Control structure for z-like coordinate generator. More...
 
type(sigma_cs), pointer sigma_cs => null()
 Control structure for sigma coordinate generator. More...
 
type(rho_cs), pointer rho_cs => null()
 Control structure for rho coordinate generator. More...
 
type(hycom_cs), pointer hycom_cs => null()
 Control structure for hybrid coordinate generator. More...
 
type(slight_cs), pointer slight_cs => null()
 Control structure for Slight-coordinate generator. More...
 
type(adapt_cs), pointer adapt_cs => null()
 Control structure for adaptive coordinate generator. More...
 

Variables and constants

◆ adapt_cs

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

Control structure for adaptive coordinate generator.

Definition at line 123 of file MOM_regridding.F90.

123  type(adapt_CS), pointer :: adapt_CS => null() !< Control structure for adaptive coordinate generator

◆ 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 104 of file MOM_regridding.F90.

104  real :: compressibility_fraction = 0.

◆ coord_scale

real mom_regridding::regridding_cs::coord_scale = 1.0

This is a scaling factor that restores coordinateResolution to values in the natural units for output.

Definition at line 55 of file MOM_regridding.F90.

55  real :: coord_scale = 1.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 coordinate. It has the units of the target coordinate, e.g. [Z ~> m] for z*, non-dimensional for sigma, etc.

Definition at line 51 of file MOM_regridding.F90.

51  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 ~> m or kg m-2].

Definition at line 100 of file MOM_regridding.F90.

100  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 ~> m or kg m-2].

Definition at line 97 of file MOM_regridding.F90.

97  real :: depth_of_time_filter_shallow = 0.

◆ hycom_cs

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

Control structure for hybrid coordinate generator.

Definition at line 121 of file MOM_regridding.F90.

121  type(hycom_CS), pointer :: hycom_CS => null() !< Control structure for hybrid coordinate generator

◆ 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 116 of file MOM_regridding.F90.

116  logical :: integrate_downward_for_e = .true.

◆ interp_cs

type(interp_cs_type) mom_regridding::regridding_cs::interp_cs

Interpolation control structure.

Definition at line 82 of file MOM_regridding.F90.

82  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 112 of file MOM_regridding.F90.

112  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 [H ~> m or kg m-2].

Definition at line 69 of file MOM_regridding.F90.

69  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 [H ~> m or kg m-2].

Definition at line 73 of file MOM_regridding.F90.

73  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 [H ~> m or kg m-2].

Definition at line 85 of file MOM_regridding.F90.

85  real :: min_thickness

◆ nk

integer mom_regridding::regridding_cs::nk

Number of layers/levels in generated grid.

Definition at line 75 of file MOM_regridding.F90.

75  integer :: nk !< Number of layers/levels in generated grid

◆ 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 94 of file MOM_regridding.F90.

94  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 88 of file MOM_regridding.F90.

88  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 79 of file MOM_regridding.F90.

79  integer :: regridding_scheme

◆ rho_cs

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

Control structure for rho coordinate generator.

Definition at line 120 of file MOM_regridding.F90.

120  type(rho_CS), pointer :: rho_CS => null() !< Control structure for rho coordinate generator

◆ 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 108 of file MOM_regridding.F90.

108  logical :: set_maximum_depths = .false.

◆ sigma_cs

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

Control structure for sigma coordinate generator.

Definition at line 119 of file MOM_regridding.F90.

119  type(sigma_CS), pointer :: sigma_CS => null() !< Control structure for sigma coordinate generator

◆ slight_cs

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

Control structure for Slight-coordinate generator.

Definition at line 122 of file MOM_regridding.F90.

122  type(slight_CS), pointer :: slight_CS => null() !< Control structure for Slight-coordinate generator

◆ 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, in [R ~> kg m-3]. i.e. target_density(k+1) = coordinateResolution(k) + coordinateResolution(k) It is only used in "rho", "SLight" or "Hycom" mode.

Definition at line 62 of file MOM_regridding.F90.

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

◆ target_density_set

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

A flag to indicate that the target_density arrays has been filled with data.

Definition at line 65 of file MOM_regridding.F90.

65  logical :: target_density_set = .false.

◆ zlike_cs

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

Control structure for z-like coordinate generator.

Definition at line 118 of file MOM_regridding.F90.

118  type(zlike_CS), pointer :: zlike_CS => null() !< Control structure for z-like coordinate generator

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