Detailed Description

ALE sponge control structure.

Definition at line 84 of file MOM_ALE_sponge.F90.

Collaboration diagram for mom_ale_sponge::ale_sponge_cs:

Public variables and constants
integer	nz
	The total number of layers. More...

integer	nz_data
	The total number of arbritary layers (used by older code). More...

integer	isc
	The starting i-index of the computational domain at h. More...

integer	iec
	The ending i-index of the computational domain at h. More...

integer	jsc
	The starting j-index of the computational domain at h. More...

integer	jec
	The ending j-index of the computational domain at h. More...

integer	iscb
	The starting I-index of the computational domain at u/v. More...

integer	iecb
	The ending I-index of the computational domain at u/v. More...

integer	jscb
	The starting J-index of the computational domain at u/v. More...

integer	jecb
	The ending J-index of the computational domain at h. More...

integer	isd
	The starting i-index of the data domain at h. More...

integer	ied
	The ending i-index of the data domain at h. More...

integer	jsd
	The starting j-index of the data domain at h. More...

integer	jed
	The ending j-index of the data domain at h. More...

integer	num_col
	The number of sponge tracer points within the computational domain. More...

integer	num_col_u
	The number of sponge u-points within the computational domain. More...

integer	num_col_v
	The number of sponge v-points within the computational domain. More...

integer	fldno = 0
	The number of fields which have already been registered by calls to set_up_sponge_field. More...

logical	sponge_uv
	Control whether u and v are included in sponge. More...

integer, dimension(:), pointer	col_i => NULL()
	Array of the i-indicies of each tracer columns being damped. More...

integer, dimension(:), pointer	col_j => NULL()
	Array of the j-indicies of each tracer columns being damped. More...

integer, dimension(:), pointer	col_i_u => NULL()
	Array of the i-indicies of each u-columns being damped. More...

integer, dimension(:), pointer	col_j_u => NULL()
	Array of the j-indicies of each u-columns being damped. More...

integer, dimension(:), pointer	col_i_v => NULL()
	Array of the i-indicies of each v-columns being damped. More...

integer, dimension(:), pointer	col_j_v => NULL()
	Array of the j-indicies of each v-columns being damped. More...

real, dimension(:), pointer	iresttime_col => NULL()
	The inverse restoring time of each tracer column [T-1 ~> s-1]. More...

real, dimension(:), pointer	iresttime_col_u => NULL()
	The inverse restoring time of each u-column [T-1 ~> s-1]. More...

real, dimension(:), pointer	iresttime_col_v => NULL()
	The inverse restoring time of each v-column [T-1 ~> s-1]. More...

type(p3d), dimension(50)	var
	Pointers to the fields that are being damped. More...

type(p2d), dimension(50)	ref_val
	The values to which the fields are damped. More...

type(p2d)	ref_val_u
	The values to which the u-velocities are damped. More...

type(p2d)	ref_val_v
	The values to which the v-velocities are damped. More...

type(p3d)	var_u
	Pointer to the u velocities. that are being damped. More...

type(p3d)	var_v
	Pointer to the v velocities. that are being damped. More...

type(p2d)	ref_h
	Grid on which reference data is provided (older code). More...

type(p2d)	ref_hu
	u-point grid on which reference data is provided (older code). More...

type(p2d)	ref_hv
	v-point grid on which reference data is provided (older code). More...

type(diag_ctrl), pointer	diag
	A structure that is used to regulate the timing of diagnostic output. More...

type(remapping_cs)	remap_cs
	Remapping parameters and work arrays. More...

logical	time_varying_sponges
	True if using newer sponge code. More...

logical	spongedataongrid
	True if the sponge data are on the model horizontal grid. More...

Variables and constants

◆ col_i

integer, dimension(:), pointer mom_ale_sponge::ale_sponge_cs::col_i => NULL()

Array of the i-indicies of each tracer columns being damped.

Definition at line 105 of file MOM_ALE_sponge.F90.

105 integer, pointer :: col_i(:) => null() !< Array of the i-indicies of each tracer columns being damped.

◆ col_i_u

integer, dimension(:), pointer mom_ale_sponge::ale_sponge_cs::col_i_u => NULL()

Array of the i-indicies of each u-columns being damped.

Definition at line 107 of file MOM_ALE_sponge.F90.

107 integer, pointer :: col_i_u(:) => null() !< Array of the i-indicies of each u-columns being damped.

◆ col_i_v

integer, dimension(:), pointer mom_ale_sponge::ale_sponge_cs::col_i_v => NULL()

Array of the i-indicies of each v-columns being damped.

Definition at line 109 of file MOM_ALE_sponge.F90.

109 integer, pointer :: col_i_v(:) => null() !< Array of the i-indicies of each v-columns being damped.

◆ col_j

integer, dimension(:), pointer mom_ale_sponge::ale_sponge_cs::col_j => NULL()

Array of the j-indicies of each tracer columns being damped.

Definition at line 106 of file MOM_ALE_sponge.F90.

106 integer, pointer :: col_j(:) => null() !< Array of the j-indicies of each tracer columns being damped.

◆ col_j_u

integer, dimension(:), pointer mom_ale_sponge::ale_sponge_cs::col_j_u => NULL()

Array of the j-indicies of each u-columns being damped.

Definition at line 108 of file MOM_ALE_sponge.F90.

108 integer, pointer :: col_j_u(:) => null() !< Array of the j-indicies of each u-columns being damped.

◆ col_j_v

integer, dimension(:), pointer mom_ale_sponge::ale_sponge_cs::col_j_v => NULL()

Array of the j-indicies of each v-columns being damped.

Definition at line 110 of file MOM_ALE_sponge.F90.

110 integer, pointer :: col_j_v(:) => null() !< Array of the j-indicies of each v-columns being damped.

◆ diag

type(diag_ctrl), pointer mom_ale_sponge::ale_sponge_cs::diag

A structure that is used to regulate the timing of diagnostic output.

Definition at line 126 of file MOM_ALE_sponge.F90.

126 type(diag_ctrl), pointer :: diag !< A structure that is used to regulate the

◆ fldno

integer mom_ale_sponge::ale_sponge_cs::fldno = 0

The number of fields which have already been registered by calls to set_up_sponge_field.

Definition at line 102 of file MOM_ALE_sponge.F90.

102 integer :: fldno = 0 !< The number of fields which have already been

◆ iec

integer mom_ale_sponge::ale_sponge_cs::iec

The ending i-index of the computational domain at h.

Definition at line 88 of file MOM_ALE_sponge.F90.

88 integer :: iec !< The ending i-index of the computational domain at h.

◆ iecb

integer mom_ale_sponge::ale_sponge_cs::iecb

The ending I-index of the computational domain at u/v.

Definition at line 92 of file MOM_ALE_sponge.F90.

92 integer :: IecB !< The ending I-index of the computational domain at u/v.

◆ ied

integer mom_ale_sponge::ale_sponge_cs::ied

The ending i-index of the data domain at h.

Definition at line 96 of file MOM_ALE_sponge.F90.

96 integer :: ied !< The ending i-index of the data domain at h.

◆ iresttime_col

real, dimension(:), pointer mom_ale_sponge::ale_sponge_cs::iresttime_col => NULL()

The inverse restoring time of each tracer column [T-1 ~> s-1].

Definition at line 112 of file MOM_ALE_sponge.F90.

112 real, pointer :: Iresttime_col(:) => null() !< The inverse restoring time of each tracer column [T-1 ~> s-1].

◆ iresttime_col_u

real, dimension(:), pointer mom_ale_sponge::ale_sponge_cs::iresttime_col_u => NULL()

The inverse restoring time of each u-column [T-1 ~> s-1].

Definition at line 113 of file MOM_ALE_sponge.F90.

113 real, pointer :: Iresttime_col_u(:) => null() !< The inverse restoring time of each u-column [T-1 ~> s-1].

◆ iresttime_col_v

real, dimension(:), pointer mom_ale_sponge::ale_sponge_cs::iresttime_col_v => NULL()

The inverse restoring time of each v-column [T-1 ~> s-1].

Definition at line 114 of file MOM_ALE_sponge.F90.

114 real, pointer :: Iresttime_col_v(:) => null() !< The inverse restoring time of each v-column [T-1 ~> s-1].

◆ isc

integer mom_ale_sponge::ale_sponge_cs::isc

The starting i-index of the computational domain at h.

Definition at line 87 of file MOM_ALE_sponge.F90.

87 integer :: isc !< The starting i-index of the computational domain at h.

◆ iscb

integer mom_ale_sponge::ale_sponge_cs::iscb

The starting I-index of the computational domain at u/v.

Definition at line 91 of file MOM_ALE_sponge.F90.

91 integer :: IscB !< The starting I-index of the computational domain at u/v.

◆ isd

integer mom_ale_sponge::ale_sponge_cs::isd

The starting i-index of the data domain at h.

Definition at line 95 of file MOM_ALE_sponge.F90.

95 integer :: isd !< The starting i-index of the data domain at h.

◆ jec

integer mom_ale_sponge::ale_sponge_cs::jec

The ending j-index of the computational domain at h.

Definition at line 90 of file MOM_ALE_sponge.F90.

90 integer :: jec !< The ending j-index of the computational domain at h.

◆ jecb

integer mom_ale_sponge::ale_sponge_cs::jecb

The ending J-index of the computational domain at h.

Definition at line 94 of file MOM_ALE_sponge.F90.

94 integer :: JecB !< The ending J-index of the computational domain at h.

◆ jed

integer mom_ale_sponge::ale_sponge_cs::jed

The ending j-index of the data domain at h.

Definition at line 98 of file MOM_ALE_sponge.F90.

98 integer :: jed !< The ending j-index of the data domain at h.

◆ jsc

integer mom_ale_sponge::ale_sponge_cs::jsc

The starting j-index of the computational domain at h.

Definition at line 89 of file MOM_ALE_sponge.F90.

89 integer :: jsc !< The starting j-index of the computational domain at h.

◆ jscb

integer mom_ale_sponge::ale_sponge_cs::jscb

The starting J-index of the computational domain at u/v.

Definition at line 93 of file MOM_ALE_sponge.F90.

93 integer :: JscB !< The starting J-index of the computational domain at u/v.

◆ jsd

integer mom_ale_sponge::ale_sponge_cs::jsd

The starting j-index of the data domain at h.

Definition at line 97 of file MOM_ALE_sponge.F90.

97 integer :: jsd !< The starting j-index of the data domain at h.

◆ num_col

integer mom_ale_sponge::ale_sponge_cs::num_col

The number of sponge tracer points within the computational domain.

Definition at line 99 of file MOM_ALE_sponge.F90.

99 integer :: num_col !< The number of sponge tracer points within the computational domain.

◆ num_col_u

integer mom_ale_sponge::ale_sponge_cs::num_col_u

The number of sponge u-points within the computational domain.

Definition at line 100 of file MOM_ALE_sponge.F90.

100 integer :: num_col_u !< The number of sponge u-points within the computational domain.

◆ num_col_v

integer mom_ale_sponge::ale_sponge_cs::num_col_v

The number of sponge v-points within the computational domain.

Definition at line 101 of file MOM_ALE_sponge.F90.

101 integer :: num_col_v !< The number of sponge v-points within the computational domain.

◆ nz

integer mom_ale_sponge::ale_sponge_cs::nz

The total number of layers.

Definition at line 85 of file MOM_ALE_sponge.F90.

85 integer :: nz !< The total number of layers.

◆ nz_data

integer mom_ale_sponge::ale_sponge_cs::nz_data

The total number of arbritary layers (used by older code).

Definition at line 86 of file MOM_ALE_sponge.F90.

86 integer :: nz_data !< The total number of arbritary layers (used by older code).

◆ ref_h

type(p2d) mom_ale_sponge::ale_sponge_cs::ref_h

Grid on which reference data is provided (older code).

Definition at line 122 of file MOM_ALE_sponge.F90.

122 type(p2d) :: Ref_h !< Grid on which reference data is provided (older code).

◆ ref_hu

type(p2d) mom_ale_sponge::ale_sponge_cs::ref_hu

u-point grid on which reference data is provided (older code).

Definition at line 123 of file MOM_ALE_sponge.F90.

123 type(p2d) :: Ref_hu !< u-point grid on which reference data is provided (older code).

◆ ref_hv

type(p2d) mom_ale_sponge::ale_sponge_cs::ref_hv

v-point grid on which reference data is provided (older code).

Definition at line 124 of file MOM_ALE_sponge.F90.

124 type(p2d) :: Ref_hv !< v-point grid on which reference data is provided (older code).

◆ ref_val

type(p2d), dimension( 50 ) mom_ale_sponge::ale_sponge_cs::ref_val

The values to which the fields are damped.

Definition at line 117 of file MOM_ALE_sponge.F90.

117 type(p2d) :: Ref_val(MAX_FIELDS_) !< The values to which the fields are damped.

◆ ref_val_u

type(p2d) mom_ale_sponge::ale_sponge_cs::ref_val_u

The values to which the u-velocities are damped.

Definition at line 118 of file MOM_ALE_sponge.F90.

118 type(p2d) :: Ref_val_u !< The values to which the u-velocities are damped.

◆ ref_val_v

type(p2d) mom_ale_sponge::ale_sponge_cs::ref_val_v

The values to which the v-velocities are damped.

Definition at line 119 of file MOM_ALE_sponge.F90.

119 type(p2d) :: Ref_val_v !< The values to which the v-velocities are damped.

◆ remap_cs

type(remapping_cs) mom_ale_sponge::ale_sponge_cs::remap_cs

Remapping parameters and work arrays.

Definition at line 129 of file MOM_ALE_sponge.F90.

129 type(remapping_cs) :: remap_cs !< Remapping parameters and work arrays

◆ sponge_uv

logical mom_ale_sponge::ale_sponge_cs::sponge_uv

Control whether u and v are included in sponge.

Definition at line 104 of file MOM_ALE_sponge.F90.

104 logical :: sponge_uv !< Control whether u and v are included in sponge

◆ spongedataongrid

logical mom_ale_sponge::ale_sponge_cs::spongedataongrid

True if the sponge data are on the model horizontal grid.

Definition at line 132 of file MOM_ALE_sponge.F90.

132 logical :: spongeDataOngrid !< True if the sponge data are on the model horizontal grid

◆ time_varying_sponges

logical mom_ale_sponge::ale_sponge_cs::time_varying_sponges

True if using newer sponge code.

Definition at line 131 of file MOM_ALE_sponge.F90.

131 logical :: time_varying_sponges !< True if using newer sponge code

◆ var

type(p3d), dimension( 50 ) mom_ale_sponge::ale_sponge_cs::var

Pointers to the fields that are being damped.

Definition at line 116 of file MOM_ALE_sponge.F90.

116 type(p3d) :: var(MAX_FIELDS_) !< Pointers to the fields that are being damped.

◆ var_u

type(p3d) mom_ale_sponge::ale_sponge_cs::var_u

Pointer to the u velocities. that are being damped.

Definition at line 120 of file MOM_ALE_sponge.F90.

120 type(p3d) :: var_u !< Pointer to the u velocities. that are being damped.

◆ var_v

type(p3d) mom_ale_sponge::ale_sponge_cs::var_v

Pointer to the v velocities. that are being damped.

Definition at line 121 of file MOM_ALE_sponge.F90.

121 type(p3d) :: var_v !< Pointer to the v velocities. that are being damped.

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

/glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/src/parameterizations/vertical/MOM_ALE_sponge.F90