MOM6
mom_ale_sponge::ale_sponge_cs Type Reference

Detailed Description

SPONGE control structure.

Definition at line 42 of file MOM_ALE_sponge.F90.

Collaboration diagram for mom_ale_sponge::ale_sponge_cs:
[legend]

Public variables and constants

integer nz
 The total number of layers. More...
 
integer nz_data
 The total number of arbritary layers. More...
 
integer isc
 
integer iec
 
integer jsc
 
integer jec
 The index ranges of the computational domain at h. More...
 
integer iscb
 
integer iecb
 
integer jscb
 
integer jecb
 The index ranges of the computational domain at u/v. More...
 
integer isd
 
integer ied
 
integer jsd
 
integer jed
 The index ranges of the data domain. More...
 
integer num_col
 
integer num_col_u
 
integer num_col_v
 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...
 
logical sponge_uv
 Control whether u and v are included in sponge. More...
 
integer, dimension(:), pointer col_i => NULL()
 Arrays containing the i- and j- indicies. More...
 
integer, dimension(:), pointer col_j => NULL()
 
integer, dimension(:), pointer col_i_u => NULL()
 Same as above for u points. More...
 
integer, dimension(:), pointer col_j_u => NULL()
 
integer, dimension(:), pointer col_i_v => NULL()
 Same as above for v points. More...
 
integer, dimension(:), pointer col_j_v => NULL()
 
real, dimension(:), pointer iresttime_col => NULL()
 The inverse restoring time of each column. More...
 
real, dimension(:), pointer iresttime_col_u => NULL()
 Same as above for u points. More...
 
real, dimension(:), pointer iresttime_col_v => NULL()
 Same as above for v points. 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...
 
real, dimension(:,:), pointer ref_val_u => NULL()
 Same as above for u points. More...
 
real, dimension(:,:), pointer ref_val_v => NULL()
 Same as above for v points. More...
 
real, dimension(:,:,:), pointer var_u => NULL()
 Pointers to the u vel. that are being damped. More...
 
real, dimension(:,:,:), pointer var_v => NULL()
 Pointers to the v vel. that are being damped. More...
 
real, dimension(:,:), pointer ref_h => NULL()
 Grid on which reference data is provided. More...
 
real, dimension(:,:), pointer ref_hu => NULL()
 Same as above for u points. More...
 
real, dimension(:,:), pointer ref_hv => NULL()
 Same as above for v points. 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...
 

Variables and constants

◆ col_i

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

Arrays containing the i- and j- indicies.

Definition at line 54 of file MOM_ALE_sponge.F90.

54  integer, pointer :: col_i(:) => null() !< Arrays containing the i- and j- indicies

◆ col_i_u

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

Same as above for u points.

Definition at line 56 of file MOM_ALE_sponge.F90.

56  integer, pointer :: col_i_u(:) => null() !< Same as above for u points

◆ col_i_v

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

Same as above for v points.

Definition at line 58 of file MOM_ALE_sponge.F90.

58  integer, pointer :: col_i_v(:) => null() !< Same as above for v points

◆ col_j

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

Definition at line 55 of file MOM_ALE_sponge.F90.

55  integer, pointer :: col_j(:) => null() !! of each of the columns being damped.

◆ col_j_u

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

Definition at line 57 of file MOM_ALE_sponge.F90.

57  integer, pointer :: col_j_u(:) => null()

◆ col_j_v

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

Definition at line 59 of file MOM_ALE_sponge.F90.

59  integer, pointer :: col_j_v(:) => null()

◆ 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 78 of file MOM_ALE_sponge.F90.

78  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 51 of file MOM_ALE_sponge.F90.

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

◆ iec

integer mom_ale_sponge::ale_sponge_cs::iec

Definition at line 45 of file MOM_ALE_sponge.F90.

◆ iecb

integer mom_ale_sponge::ale_sponge_cs::iecb

Definition at line 46 of file MOM_ALE_sponge.F90.

◆ ied

integer mom_ale_sponge::ale_sponge_cs::ied

Definition at line 47 of file MOM_ALE_sponge.F90.

◆ iresttime_col

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

The inverse restoring time of each column.

Definition at line 61 of file MOM_ALE_sponge.F90.

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

◆ iresttime_col_u

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

Same as above for u points.

Definition at line 63 of file MOM_ALE_sponge.F90.

63  real, pointer :: iresttime_col_u(:) => null() !< Same as above for u points

◆ iresttime_col_v

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

Same as above for v points.

Definition at line 64 of file MOM_ALE_sponge.F90.

64  real, pointer :: iresttime_col_v(:) => null() !< Same as above for v points

◆ isc

integer mom_ale_sponge::ale_sponge_cs::isc

Definition at line 45 of file MOM_ALE_sponge.F90.

45  integer :: isc, iec, jsc, jec !< The index ranges of the computational domain at h.

◆ iscb

integer mom_ale_sponge::ale_sponge_cs::iscb

Definition at line 46 of file MOM_ALE_sponge.F90.

46  integer :: iscb, iecb, jscb, jecb !< The index ranges of the computational domain at u/v.

◆ isd

integer mom_ale_sponge::ale_sponge_cs::isd

Definition at line 47 of file MOM_ALE_sponge.F90.

47  integer :: isd, ied, jsd, jed !< The index ranges of the data domain.

◆ jec

integer mom_ale_sponge::ale_sponge_cs::jec

The index ranges of the computational domain at h.

Definition at line 45 of file MOM_ALE_sponge.F90.

◆ jecb

integer mom_ale_sponge::ale_sponge_cs::jecb

The index ranges of the computational domain at u/v.

Definition at line 46 of file MOM_ALE_sponge.F90.

◆ jed

integer mom_ale_sponge::ale_sponge_cs::jed

The index ranges of the data domain.

Definition at line 47 of file MOM_ALE_sponge.F90.

◆ jsc

integer mom_ale_sponge::ale_sponge_cs::jsc

Definition at line 45 of file MOM_ALE_sponge.F90.

◆ jscb

integer mom_ale_sponge::ale_sponge_cs::jscb

Definition at line 46 of file MOM_ALE_sponge.F90.

◆ jsd

integer mom_ale_sponge::ale_sponge_cs::jsd

Definition at line 47 of file MOM_ALE_sponge.F90.

◆ num_col

integer mom_ale_sponge::ale_sponge_cs::num_col

Definition at line 49 of file MOM_ALE_sponge.F90.

49  integer :: num_col, num_col_u, num_col_v !< The number of sponge points within the

◆ num_col_u

integer mom_ale_sponge::ale_sponge_cs::num_col_u

Definition at line 49 of file MOM_ALE_sponge.F90.

◆ num_col_v

integer mom_ale_sponge::ale_sponge_cs::num_col_v

The number of sponge points within the computational domain.

Definition at line 49 of file MOM_ALE_sponge.F90.

◆ nz

integer mom_ale_sponge::ale_sponge_cs::nz

The total number of layers.

Definition at line 43 of file MOM_ALE_sponge.F90.

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

◆ nz_data

integer mom_ale_sponge::ale_sponge_cs::nz_data

The total number of arbritary layers.

Definition at line 44 of file MOM_ALE_sponge.F90.

44  integer :: nz_data !< The total number of arbritary layers.

◆ ref_h

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

Grid on which reference data is provided.

Definition at line 74 of file MOM_ALE_sponge.F90.

74  real, pointer :: ref_h(:,:) => null() !< Grid on which reference data is provided

◆ ref_hu

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

Same as above for u points.

Definition at line 75 of file MOM_ALE_sponge.F90.

75  real, pointer :: ref_hu(:,:) => null() !< Same as above for u points

◆ ref_hv

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

Same as above for v points.

Definition at line 76 of file MOM_ALE_sponge.F90.

76  real, pointer :: ref_hv(:,:) => null() !< Same as above for v points

◆ 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 67 of file MOM_ALE_sponge.F90.

67  type(p2d) :: ref_val(max_fields_) !< The values to which the fields are damped.

◆ ref_val_u

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

Same as above for u points.

Definition at line 68 of file MOM_ALE_sponge.F90.

68  real, dimension(:,:), pointer :: ref_val_u => null() !< Same as above for u points

◆ ref_val_v

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

Same as above for v points.

Definition at line 69 of file MOM_ALE_sponge.F90.

69  real, dimension(:,:), pointer :: ref_val_v => null() !< Same as above for v points

◆ remap_cs

type(remapping_cs) mom_ale_sponge::ale_sponge_cs::remap_cs

Remapping parameters and work arrays.

Definition at line 81 of file MOM_ALE_sponge.F90.

81  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 53 of file MOM_ALE_sponge.F90.

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

◆ var

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

Pointers to the fields that are being damped.

Definition at line 66 of file MOM_ALE_sponge.F90.

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

◆ var_u

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

Pointers to the u vel. that are being damped.

Definition at line 70 of file MOM_ALE_sponge.F90.

70  real, dimension(:,:,:), pointer :: var_u => null() !< Pointers to the u vel. that are

◆ var_v

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

Pointers to the v vel. that are being damped.

Definition at line 72 of file MOM_ALE_sponge.F90.

72  real, dimension(:,:,:), pointer :: var_v => null() !< Pointers to the v vel. that are

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