Detailed Description

Control structure for MOM_controlled_forcing.

Definition at line 34 of file MOM_controlled_forcing.F90.

Collaboration diagram for mom_controlled_forcing::ctrl_forcing_cs:

Public variables and constants
logical	use_temperature
	If true, temperature and salinity are used as state variables. More...

logical	do_integrated
	If true, use time-integrated anomalies to control the surface state. More...

integer	num_cycle
	The number of elements in the forcing cycle. More...

real	heat_int_rate
	The rate at which heating anomalies accumulate [s-1]. More...

real	prec_int_rate
	The rate at which precipitation anomalies accumulate [s-1]. More...

real	heat_cyc_rate
	The rate at which cyclical heating anomaliess accumulate [s-1]. More...

real	prec_cyc_rate
	The rate at which cyclical precipitation anomaliess accumulate [s-1]. More...

real	len2
	The square of the length scale over which the anomalies are smoothed via a Laplacian filter [m2]. More...

real	lam_heat
	A constant of proportionality between SST anomalies and heat fluxes [W m-2 degC-1]. More...

real	lam_prec
	A constant of proportionality between SSS anomalies (normalised by mean SSS) and precipitation [kg m-2]. More...

real	lam_cyc_heat
	A constant of proportionality between cyclical SST anomalies and corrective heat fluxes [W m-2 degC-1]. More...

real	lam_cyc_prec
	A constant of proportionality between cyclical SSS anomalies (normalised by mean SSS) and corrective precipitation [kg m-2]. More...


real, dimension(:), pointer	avg_time => NULL()
	Pointers for data. More...

real, dimension(:,:), pointer	heat_0 => NULL()
	Pointers for data. More...

real, dimension(:,:), pointer	precip_0 => NULL()
	Pointers for data. More...

real, dimension(:,:,:), pointer	heat_cyc => NULL()
	Pointers for data. More...

real, dimension(:,:,:), pointer	precip_cyc => NULL()
	Pointers for data. More...

real, dimension(:,:,:), pointer	avg_sst_anom => NULL()
	Pointers for data. More...

real, dimension(:,:,:), pointer	avg_sss_anom => NULL()
	Pointers for data. More...

real, dimension(:,:,:), pointer	avg_sss => NULL()
	Pointers for data. More...

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

integer	id_heat_0 = -1
	Diagnostic handle. More...

Variables and constants

◆ avg_sss

real, dimension(:,:,:), pointer mom_controlled_forcing::ctrl_forcing_cs::avg_sss => NULL()

Pointers for data.

Todo:: Needs more complete documentation.

Definition at line 65 of file MOM_controlled_forcing.F90.

◆ avg_sss_anom

real, dimension(:,:,:), pointer mom_controlled_forcing::ctrl_forcing_cs::avg_sss_anom => NULL()

Pointers for data.

Todo:: Needs more complete documentation.

Definition at line 65 of file MOM_controlled_forcing.F90.

◆ avg_sst_anom

real, dimension(:,:,:), pointer mom_controlled_forcing::ctrl_forcing_cs::avg_sst_anom => NULL()

Pointers for data.

Todo:: Needs more complete documentation.

Definition at line 65 of file MOM_controlled_forcing.F90.

◆ avg_time

real, dimension(:), pointer mom_controlled_forcing::ctrl_forcing_cs::avg_time => NULL()

Pointers for data.

Todo:: Needs more complete documentation.

Definition at line 60 of file MOM_controlled_forcing.F90.

60 real, pointer, dimension(:) :: &

61 avg_time => null()

◆ diag

type(diag_ctrl), pointer mom_controlled_forcing::ctrl_forcing_cs::diag => NULL()

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

Definition at line 72 of file MOM_controlled_forcing.F90.

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

◆ do_integrated

logical mom_controlled_forcing::ctrl_forcing_cs::do_integrated

If true, use time-integrated anomalies to control the surface state.

Definition at line 37 of file MOM_controlled_forcing.F90.

37 logical :: do_integrated !< If true, use time-integrated anomalies to control

◆ heat_0

real, dimension(:,:), pointer mom_controlled_forcing::ctrl_forcing_cs::heat_0 => NULL()

Pointers for data.

Todo:: Needs more complete documentation.

Definition at line 62 of file MOM_controlled_forcing.F90.

   real, pointer, dimension(:,:) :: &
     heat_0 => null(), &
     precip_0 => null()

◆ heat_cyc

real, dimension(:,:,:), pointer mom_controlled_forcing::ctrl_forcing_cs::heat_cyc => NULL()

Pointers for data.

Todo:: Needs more complete documentation.

Definition at line 65 of file MOM_controlled_forcing.F90.

   real, pointer, dimension(:,:,:) :: &
     heat_cyc => null(), &
     precip_cyc => null(), &
     avg_sst_anom => null(), &
     avg_sss_anom => null(), &
     avg_sss => null()

◆ heat_cyc_rate

real mom_controlled_forcing::ctrl_forcing_cs::heat_cyc_rate

The rate at which cyclical heating anomaliess accumulate [s-1].

Definition at line 42 of file MOM_controlled_forcing.F90.

42 real :: heat_cyc_rate !< The rate at which cyclical heating anomaliess

◆ heat_int_rate

real mom_controlled_forcing::ctrl_forcing_cs::heat_int_rate

The rate at which heating anomalies accumulate [s-1].

Definition at line 40 of file MOM_controlled_forcing.F90.

40 real :: heat_int_rate !< The rate at which heating anomalies accumulate [s-1].

◆ id_heat_0

integer mom_controlled_forcing::ctrl_forcing_cs::id_heat_0 = -1

Diagnostic handle.

Definition at line 74 of file MOM_controlled_forcing.F90.

74 integer :: id_heat_0 = -1 !< Diagnostic handle

◆ lam_cyc_heat

real mom_controlled_forcing::ctrl_forcing_cs::lam_cyc_heat

A constant of proportionality between cyclical SST anomalies and corrective heat fluxes [W m-2 degC-1].

Definition at line 52 of file MOM_controlled_forcing.F90.

52 real :: lam_cyc_heat !< A constant of proportionality between cyclical SST

◆ lam_cyc_prec

real mom_controlled_forcing::ctrl_forcing_cs::lam_cyc_prec

A constant of proportionality between cyclical SSS anomalies (normalised by mean SSS) and corrective precipitation [kg m-2].

Definition at line 54 of file MOM_controlled_forcing.F90.

54 real :: lam_cyc_prec !< A constant of proportionality between cyclical SSS

◆ lam_heat

real mom_controlled_forcing::ctrl_forcing_cs::lam_heat

A constant of proportionality between SST anomalies and heat fluxes [W m-2 degC-1].

Definition at line 48 of file MOM_controlled_forcing.F90.

48 real :: lam_heat !< A constant of proportionality between SST anomalies

◆ lam_prec

real mom_controlled_forcing::ctrl_forcing_cs::lam_prec

A constant of proportionality between SSS anomalies (normalised by mean SSS) and precipitation [kg m-2].

Definition at line 50 of file MOM_controlled_forcing.F90.

50 real :: lam_prec !< A constant of proportionality between SSS anomalies

◆ len2

real mom_controlled_forcing::ctrl_forcing_cs::len2

The square of the length scale over which the anomalies are smoothed via a Laplacian filter [m2].

Definition at line 46 of file MOM_controlled_forcing.F90.

46 real :: Len2 !< The square of the length scale over which the anomalies

◆ num_cycle

integer mom_controlled_forcing::ctrl_forcing_cs::num_cycle

The number of elements in the forcing cycle.

Definition at line 39 of file MOM_controlled_forcing.F90.

39 integer :: num_cycle !< The number of elements in the forcing cycle.

◆ prec_cyc_rate

real mom_controlled_forcing::ctrl_forcing_cs::prec_cyc_rate

The rate at which cyclical precipitation anomaliess accumulate [s-1].

Definition at line 44 of file MOM_controlled_forcing.F90.

44 real :: prec_cyc_rate !< The rate at which cyclical precipitation anomaliess

◆ prec_int_rate

real mom_controlled_forcing::ctrl_forcing_cs::prec_int_rate

The rate at which precipitation anomalies accumulate [s-1].

Definition at line 41 of file MOM_controlled_forcing.F90.

41 real :: prec_int_rate !< The rate at which precipitation anomalies accumulate [s-1].

◆ precip_0

real, dimension(:,:), pointer mom_controlled_forcing::ctrl_forcing_cs::precip_0 => NULL()

Pointers for data.

Todo:: Needs more complete documentation.

Definition at line 62 of file MOM_controlled_forcing.F90.

◆ precip_cyc

real, dimension(:,:,:), pointer mom_controlled_forcing::ctrl_forcing_cs::precip_cyc => NULL()

Pointers for data.

Todo:: Needs more complete documentation.

Definition at line 65 of file MOM_controlled_forcing.F90.

◆ use_temperature

logical mom_controlled_forcing::ctrl_forcing_cs::use_temperature

If true, temperature and salinity are used as state variables.

Definition at line 35 of file MOM_controlled_forcing.F90.

35 logical :: use_temperature !< If true, temperature and salinity are used as

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/user/MOM_controlled_forcing.F90

Detailed Description

Public variables and constants

Variables and constants

◆ avg_sss

◆ avg_sss_anom

◆ avg_sst_anom

◆ avg_time

◆ diag

◆ do_integrated

◆ heat_0

◆ heat_cyc

◆ heat_cyc_rate

◆ heat_int_rate

◆ id_heat_0

◆ lam_cyc_heat

◆ lam_cyc_prec

◆ lam_heat

◆ lam_prec

◆ len2

◆ num_cycle

◆ prec_cyc_rate

◆ prec_int_rate

◆ precip_0

◆ precip_cyc

◆ use_temperature