Detailed Description

The control structure for the MOM_tidal_forcing module.

Definition at line 26 of file MOM_tidal_forcing.F90.

Collaboration diagram for mom_tidal_forcing::tidal_forcing_cs:

Public variables and constants
logical	use_sal_scalar
	If true, use the scalar approximation when calculating self-attraction and loading. More...

logical	tidal_sal_from_file
	If true, Read the tidal self-attraction and loading from input files, specified by TIDAL_INPUT_FILE. More...

logical	use_prev_tides
	If true, use the SAL from the previous iteration of the tides to facilitate convergence. More...

real	sal_scalar
	The constant of proportionality between sea surface height (really it should be bottom pressure) anomalies and bottom geopotential anomalies. More...

integer	nc
	The number of tidal constituents in use. More...

real, dimension(max_constituents)	freq
	The frequency of a tidal constituent [s-1]. More...

real, dimension(max_constituents)	phase0
	The phase of a tidal constituent at time 0, in radians. More...

real, dimension(max_constituents)	amp
	The amplitude of a tidal constituent at time 0 [m]. More...

real, dimension(max_constituents)	love_no
	The Love number of a tidal constituent at time 0 [nondim]. More...

integer, dimension(max_constituents)	struct
	An encoded spatial structure for each constituent. More...

character(len=16), dimension(max_constituents)	const_name
	The name of each constituent. More...

real, dimension(:,:,:), pointer	sin_struct => NULL()
	The sine and cosine based structures that can. More...

real, dimension(:,:,:), pointer	cos_struct => NULL()
	be associated with the astronomical forcing. More...

real, dimension(:,:,:), pointer	cosphasesal => NULL()
	The cosine and sine of the phase of the. More...

real, dimension(:,:,:), pointer	sinphasesal => NULL()
	self-attraction and loading amphidromes. More...

real, dimension(:,:,:), pointer	ampsal => NULL()
	The amplitude of the SAL [m]. More...

real, dimension(:,:,:), pointer	cosphase_prev => NULL()
	The cosine and sine of the phase of the. More...

real, dimension(:,:,:), pointer	sinphase_prev => NULL()
	amphidromes in the previous tidal solutions. More...

real, dimension(:,:,:), pointer	amp_prev => NULL()
	The amplitude of the previous tidal solution [m]. More...

Variables and constants

◆ amp

real, dimension(max_constituents) mom_tidal_forcing::tidal_forcing_cs::amp

The amplitude of a tidal constituent at time 0 [m].

Definition at line 38 of file MOM_tidal_forcing.F90.

◆ amp_prev

real, dimension(:,:,:), pointer mom_tidal_forcing::tidal_forcing_cs::amp_prev => NULL()

The amplitude of the previous tidal solution [m].

Definition at line 46 of file MOM_tidal_forcing.F90.

◆ ampsal

real, dimension(:,:,:), pointer mom_tidal_forcing::tidal_forcing_cs::ampsal => NULL()

The amplitude of the SAL [m].

Definition at line 46 of file MOM_tidal_forcing.F90.

◆ const_name

character (len=16), dimension(max_constituents) mom_tidal_forcing::tidal_forcing_cs::const_name

The name of each constituent.

Definition at line 44 of file MOM_tidal_forcing.F90.

44 character (len=16) :: const_name(MAX_CONSTITUENTS) !< The name of each constituent

◆ cos_struct

real, dimension(:,:,:), pointer mom_tidal_forcing::tidal_forcing_cs::cos_struct => NULL()

be associated with the astronomical forcing.

Definition at line 46 of file MOM_tidal_forcing.F90.

◆ cosphase_prev

real, dimension(:,:,:), pointer mom_tidal_forcing::tidal_forcing_cs::cosphase_prev => NULL()

The cosine and sine of the phase of the.

Definition at line 46 of file MOM_tidal_forcing.F90.

◆ cosphasesal

real, dimension(:,:,:), pointer mom_tidal_forcing::tidal_forcing_cs::cosphasesal => NULL()

The cosine and sine of the phase of the.

Definition at line 46 of file MOM_tidal_forcing.F90.

◆ freq

real, dimension(max_constituents) mom_tidal_forcing::tidal_forcing_cs::freq

The frequency of a tidal constituent [s-1].

Definition at line 38 of file MOM_tidal_forcing.F90.

   real, dimension(MAX_CONSTITUENTS) :: &
     freq, &           !< The frequency of a tidal constituent [s-1].
     phase0, &         !< The phase of a tidal constituent at time 0, in radians.
     amp, &            !< The amplitude of a tidal constituent at time 0 [m].
     love_no           !< The Love number of a tidal constituent at time 0 [nondim].

◆ love_no

real, dimension(max_constituents) mom_tidal_forcing::tidal_forcing_cs::love_no

The Love number of a tidal constituent at time 0 [nondim].

Definition at line 38 of file MOM_tidal_forcing.F90.

◆ nc

integer mom_tidal_forcing::tidal_forcing_cs::nc

The number of tidal constituents in use.

Definition at line 37 of file MOM_tidal_forcing.F90.

37 integer :: nc !< The number of tidal constituents in use.

◆ phase0

real, dimension(max_constituents) mom_tidal_forcing::tidal_forcing_cs::phase0

The phase of a tidal constituent at time 0, in radians.

Definition at line 38 of file MOM_tidal_forcing.F90.

◆ sal_scalar

real mom_tidal_forcing::tidal_forcing_cs::sal_scalar

The constant of proportionality between sea surface height (really it should be bottom pressure) anomalies and bottom geopotential anomalies.

Definition at line 34 of file MOM_tidal_forcing.F90.

34 real :: sal_scalar !< The constant of proportionality between sea surface

◆ sin_struct

real, dimension(:,:,:), pointer mom_tidal_forcing::tidal_forcing_cs::sin_struct => NULL()

The sine and cosine based structures that can.

Definition at line 46 of file MOM_tidal_forcing.F90.

   real, pointer, dimension(:,:,:) :: &
     sin_struct => null(), &    !< The sine and cosine based structures that can
     cos_struct => null(), &    !< be associated with the astronomical forcing.
     cosphasesal => null(), &   !< The cosine and sine of the phase of the
     sinphasesal => null(), &   !< self-attraction and loading amphidromes.
     ampsal => null(), &        !< The amplitude of the SAL [m].
     cosphase_prev => null(), & !< The cosine and sine of the phase of the
     sinphase_prev => null(), & !< amphidromes in the previous tidal solutions.
     amp_prev => null()         !< The amplitude of the previous tidal solution [m].

◆ sinphase_prev

real, dimension(:,:,:), pointer mom_tidal_forcing::tidal_forcing_cs::sinphase_prev => NULL()

amphidromes in the previous tidal solutions.

Definition at line 46 of file MOM_tidal_forcing.F90.

◆ sinphasesal

real, dimension(:,:,:), pointer mom_tidal_forcing::tidal_forcing_cs::sinphasesal => NULL()

self-attraction and loading amphidromes.

Definition at line 46 of file MOM_tidal_forcing.F90.

◆ struct

integer, dimension(max_constituents) mom_tidal_forcing::tidal_forcing_cs::struct

An encoded spatial structure for each constituent.

Definition at line 43 of file MOM_tidal_forcing.F90.

43 integer :: struct(MAX_CONSTITUENTS) !< An encoded spatial structure for each constituent

◆ tidal_sal_from_file

logical mom_tidal_forcing::tidal_forcing_cs::tidal_sal_from_file

If true, Read the tidal self-attraction and loading from input files, specified by TIDAL_INPUT_FILE.

Definition at line 29 of file MOM_tidal_forcing.F90.

29 logical :: tidal_sal_from_file !< If true, Read the tidal self-attraction

◆ use_prev_tides

logical mom_tidal_forcing::tidal_forcing_cs::use_prev_tides

If true, use the SAL from the previous iteration of the tides to facilitate convergence.

Definition at line 32 of file MOM_tidal_forcing.F90.

32 logical :: use_prev_tides !< If true, use the SAL from the previous

◆ use_sal_scalar

logical mom_tidal_forcing::tidal_forcing_cs::use_sal_scalar

If true, use the scalar approximation when calculating self-attraction and loading.

Definition at line 27 of file MOM_tidal_forcing.F90.

27 logical :: use_sal_scalar !< If true, use the scalar approximation when

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/lateral/MOM_tidal_forcing.F90

Detailed Description

Public variables and constants

Variables and constants

◆ amp

◆ amp_prev

◆ ampsal

◆ const_name

◆ cos_struct

◆ cosphase_prev

◆ cosphasesal

◆ freq

◆ love_no

◆ nc

◆ phase0

◆ sal_scalar

◆ sin_struct

◆ sinphase_prev

◆ sinphasesal

◆ struct

◆ tidal_sal_from_file

◆ use_prev_tides

◆ use_sal_scalar