Detailed Description

This control structure holds memory and parameters for the MOM_sponge module.

Definition at line 41 of file MOM_sponge.F90.

Collaboration diagram for mom_sponge::sponge_cs:

Public variables and constants
logical	bulkmixedlayer
	If true, a refined bulk mixed layer is used with nkml sublayers and nkbl buffer layer. More...

integer	nz
	The total number of layers. 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	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 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...

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

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

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

real, dimension(:), pointer	rcv_ml_ref => NULL()
	The value toward which the mixed layer coordinate-density is being damped [R ~> kg m-3]. More...

real, dimension(:,:), pointer	ref_eta => NULL()
	The value toward which the interface heights are being damped [Z ~> m]. 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...

logical	do_i_mean_sponge
	If true, apply sponges to the i-mean fields. More...

real, dimension(:), pointer	iresttime_im => NULL()
	The inverse restoring time of each row for i-mean sponges [T-1 ~> s-1]. More...

real, dimension(:), pointer	rcv_ml_ref_im => NULL()
	mixed layer coordinate-density is being damped [R ~> kg m-3]. More...

real, dimension(:,:), pointer	ref_eta_im => NULL()
	The value toward which the i-mean interface heights are being damped [Z ~> m]. More...

type(p2d), dimension(50)	ref_val_im
	The values toward which the i-means of fields are damped. More...

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

integer	id_w_sponge = -1
	A diagnostic ID. More...

Variables and constants

◆ bulkmixedlayer

logical mom_sponge::sponge_cs::bulkmixedlayer

If true, a refined bulk mixed layer is used with nkml sublayers and nkbl buffer layer.

Definition at line 42 of file MOM_sponge.F90.

42 logical :: bulkmixedlayer !< If true, a refined bulk mixed layer is used with

◆ col_i

integer, dimension(:), pointer mom_sponge::sponge_cs::col_i => NULL()

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

Definition at line 56 of file MOM_sponge.F90.

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

◆ col_j

integer, dimension(:), pointer mom_sponge::sponge_cs::col_j => NULL()

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

Definition at line 57 of file MOM_sponge.F90.

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

◆ diag

type(diag_ctrl), pointer mom_sponge::sponge_cs::diag => NULL()

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

Definition at line 76 of file MOM_sponge.F90.

76 type(diag_ctrl), pointer :: diag => null() !< A structure that is used to

◆ do_i_mean_sponge

logical mom_sponge::sponge_cs::do_i_mean_sponge

If true, apply sponges to the i-mean fields.

Definition at line 66 of file MOM_sponge.F90.

66 logical :: do_i_mean_sponge !< If true, apply sponges to the i-mean fields.

◆ fldno

integer mom_sponge::sponge_cs::fldno = 0

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

Definition at line 54 of file MOM_sponge.F90.

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

◆ id_w_sponge

integer mom_sponge::sponge_cs::id_w_sponge = -1

A diagnostic ID.

Definition at line 78 of file MOM_sponge.F90.

78 integer :: id_w_sponge = -1 !< A diagnostic ID

◆ iec

integer mom_sponge::sponge_cs::iec

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

Definition at line 46 of file MOM_sponge.F90.

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

◆ ied

integer mom_sponge::sponge_cs::ied

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

Definition at line 50 of file MOM_sponge.F90.

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

◆ iresttime_col

real, dimension(:), pointer mom_sponge::sponge_cs::iresttime_col => NULL()

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

Definition at line 58 of file MOM_sponge.F90.

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

◆ iresttime_im

real, dimension(:), pointer mom_sponge::sponge_cs::iresttime_im => NULL()

The inverse restoring time of each row for i-mean sponges [T-1 ~> s-1].

Definition at line 67 of file MOM_sponge.F90.

67 real, pointer :: Iresttime_im(:) => null() !< The inverse restoring time of

◆ isc

integer mom_sponge::sponge_cs::isc

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

Definition at line 45 of file MOM_sponge.F90.

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

◆ isd

integer mom_sponge::sponge_cs::isd

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

Definition at line 49 of file MOM_sponge.F90.

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

◆ jec

integer mom_sponge::sponge_cs::jec

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

Definition at line 48 of file MOM_sponge.F90.

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

◆ jed

integer mom_sponge::sponge_cs::jed

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

Definition at line 52 of file MOM_sponge.F90.

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

◆ jsc

integer mom_sponge::sponge_cs::jsc

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

Definition at line 47 of file MOM_sponge.F90.

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

◆ jsd

integer mom_sponge::sponge_cs::jsd

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

Definition at line 51 of file MOM_sponge.F90.

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

◆ num_col

integer mom_sponge::sponge_cs::num_col

The number of sponge points within the computational domain.

Definition at line 53 of file MOM_sponge.F90.

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

◆ nz

integer mom_sponge::sponge_cs::nz

The total number of layers.

Definition at line 44 of file MOM_sponge.F90.

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

◆ rcv_ml_ref

real, dimension(:), pointer mom_sponge::sponge_cs::rcv_ml_ref => NULL()

The value toward which the mixed layer coordinate-density is being damped [R ~> kg m-3].

Definition at line 59 of file MOM_sponge.F90.

59 real, pointer :: Rcv_ml_ref(:) => null() !< The value toward which the mixed layer

◆ rcv_ml_ref_im

real, dimension(:), pointer mom_sponge::sponge_cs::rcv_ml_ref_im => NULL()

mixed layer coordinate-density is being damped [R ~> kg m-3].

Definition at line 69 of file MOM_sponge.F90.

69 real, pointer :: Rcv_ml_ref_im(:) => null() !! The value toward which the i-mean

◆ ref_eta

real, dimension(:,:), pointer mom_sponge::sponge_cs::ref_eta => NULL()

The value toward which the interface heights are being damped [Z ~> m].

Definition at line 61 of file MOM_sponge.F90.

61 real, pointer :: Ref_eta(:,:) => null() !< The value toward which the interface

◆ ref_eta_im

real, dimension(:,:), pointer mom_sponge::sponge_cs::ref_eta_im => NULL()

The value toward which the i-mean interface heights are being damped [Z ~> m].

Definition at line 71 of file MOM_sponge.F90.

71 real, pointer :: Ref_eta_im(:,:) => null() !< The value toward which the i-mean

◆ ref_val

type(p2d), dimension( 50 ) mom_sponge::sponge_cs::ref_val

The values to which the fields are damped.

Definition at line 64 of file MOM_sponge.F90.

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

◆ ref_val_im

type(p2d), dimension( 50 ) mom_sponge::sponge_cs::ref_val_im

The values toward which the i-means of fields are damped.

Definition at line 73 of file MOM_sponge.F90.

73 type(p2d) :: Ref_val_im(MAX_FIELDS_) !< The values toward which the i-means of

◆ var

type(p3d), dimension( 50 ) mom_sponge::sponge_cs::var

Pointers to the fields that are being damped.

Definition at line 63 of file MOM_sponge.F90.

63 type(p3d) :: var(MAX_FIELDS_) !< Pointers to the fields 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_sponge.F90