ocean_tides_config_t Derived Type

type, public :: ocean_tides_config_t

Equilibrium (astronomical) body-force tide (&ocean_tides_nml, capability C1). Drives -g grad(eta - eta_eq) in the barotropic momentum solve from a set of harmonic constituents. enable = .false. keeps the existing path bit-identical. Requires a non-cartesian grid (needs lat/lon).


Inherited by

type~~ocean_tides_config_t~~InheritedByGraph type~ocean_tides_config_t ocean_tides_config_t type~ocean_config_t ocean_config_t type~ocean_config_t->type~ocean_tides_config_t tides type~config_t config_t type~config_t->type~ocean_config_t ocean type~ocean_handle_t ocean_handle_t type~ocean_handle_t->type~config_t cfg

Components

Type Visibility Attributes Name Initial
logical, public :: add_nodal = .false.

Apply the 18.6-yr nodal f/u corrections (fixed at nodal_ref_date).
real(kind=wp), public :: beta_sal = 0.0_wp

Scalar SAL factor beta (~0.085-0.12); eta_sal = beta_sal*eta.
character(len=64), public :: constituents = "M2 S2 N2 K2 K1 O1 P1 Q1"

Whitespace/comma-separated active constituent list.
logical, public :: enable = .false.

Master switch (default off => bit-identical).
character(len=16), public :: nodal_ref_date = ""

Nodal reference date; “” => ref_date.
character(len=16), public :: ref_date = "1900-01-01"

Astronomical reference date “YYYY-MM-DD”; model t=0 == ref_date.
logical, public :: use_sal = .false.

Apply scalar self-attraction & loading (C2). Default off => bit-identical.

Source Code

   type :: ocean_tides_config_t
      !! Equilibrium (astronomical) body-force tide (`&ocean_tides_nml`,
      !! capability C1).  Drives `-g grad(eta - eta_eq)` in the barotropic
      !! momentum solve from a set of harmonic constituents.  `enable =
      !! .false.` keeps the existing path bit-identical.  Requires a
      !! non-cartesian grid (needs lat/lon).
      logical :: enable = .false.
         !! Master switch (default off => bit-identical).
      logical :: use_sal = .false.
         !! Apply scalar self-attraction & loading (C2). Default off =>
         !! bit-identical.
      real(wp) :: beta_sal = 0.0_wp
         !! Scalar SAL factor beta (~0.085-0.12); `eta_sal = beta_sal*eta`.
      logical :: add_nodal = .false.
         !! Apply the 18.6-yr nodal f/u corrections (fixed at nodal_ref_date).
      character(len=64) :: constituents = "M2 S2 N2 K2 K1 O1 P1 Q1"
         !! Whitespace/comma-separated active constituent list.
      character(len=16) :: ref_date = "1900-01-01"
         !! Astronomical reference date "YYYY-MM-DD"; model t=0 == ref_date.
      character(len=16) :: nodal_ref_date = ""
         !! Nodal reference date; "" => ref_date.
   end type ocean_tides_config_t