Detailed Description

Control structure for mom_mixed_layer_restrat.

Definition at line 32 of file MOM_mixed_layer_restrat.F90.

Collaboration diagram for mom_mixed_layer_restrat::mixedlayer_restrat_cs:

Public variables and constants
real	ml_restrat_coef
	A non-dimensional factor by which the instability is enhanced over what would be predicted based on the resolved gradients. This increases with grid spacing^2, up to something of order 500. More...

real	ml_restrat_coef2
	As for ml_restrat_coef but using the slow filtered MLD. More...

real	front_length
	If non-zero, is the frontal-length scale used to calculate the upscaling of buoyancy gradients that is otherwise represented by the parameter FOX_KEMPER_ML_RESTRAT_COEF. If MLE_FRONT_LENGTH is non-zero, it is recommended to set FOX_KEMPER_ML_RESTRAT_COEF=1.0. More...

logical	mle_use_pbl_mld
	If true, use the MLD provided by the PBL parameterization. if false, MLE will calculate a MLD based on a density difference based on the parameter MLE_DENSITY_DIFF. More...

real	mle_mld_decay_time
	Time-scale to use in a running-mean when MLD is retreating (s). More...

real	mle_mld_decay_time2
	Time-scale to use in a running-mean when filtered MLD is retreating (s). More...

real	mle_density_diff
	Density difference used in detecting mixed-layer depth (kg/m3). More...

real	mle_tail_dh
	Fraction by which to extend the mixed-layer restratification depth used for a smoother stream function at the base of the mixed-layer. More...

real	mle_mld_stretch
	A scaling coefficient for stretching/shrinking the MLD used in the MLE scheme. This simply multiplies MLD wherever used. More...

logical	mle_use_mld_ave_bug
	If true, do not account for MLD mismatch to interface positions. More...

logical	debug = .false.
	If true, calculate checksums of fields for debugging. More...

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

real, dimension(:,:), pointer	mld_filtered => NULL()
	Time-filtered MLD (H units) More...

real, dimension(:,:), pointer	mld_filtered_slow => NULL()
	Slower time-filtered MLD (H units) More...


integer	id_urestrat_time = -1
	Diagnostic identifier. More...

integer	id_vrestrat_time = -1
	Diagnostic identifier. More...

integer	id_uhml = -1
	Diagnostic identifier. More...

integer	id_vhml = -1
	Diagnostic identifier. More...

integer	id_mld = -1
	Diagnostic identifier. More...

integer	id_rml = -1
	Diagnostic identifier. More...

integer	id_udml = -1
	Diagnostic identifier. More...

integer	id_vdml = -1
	Diagnostic identifier. More...

integer	id_uml = -1
	Diagnostic identifier. More...

integer	id_vml = -1
	Diagnostic identifier. More...

Variables and constants

◆ debug

logical mom_mixed_layer_restrat::mixedlayer_restrat_cs::debug = .false.

If true, calculate checksums of fields for debugging.

Definition at line 56 of file MOM_mixed_layer_restrat.F90.

56 logical :: debug = .false. !< If true, calculate checksums of fields for debugging.

◆ diag

type(diag_ctrl), pointer mom_mixed_layer_restrat::mixedlayer_restrat_cs::diag

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

Definition at line 57 of file MOM_mixed_layer_restrat.F90.

57 type(diag_ctrl), pointer :: diag !< A structure that is used to regulate the

◆ front_length

real mom_mixed_layer_restrat::mixedlayer_restrat_cs::front_length

If non-zero, is the frontal-length scale used to calculate the upscaling of buoyancy gradients that is otherwise represented by the parameter FOX_KEMPER_ML_RESTRAT_COEF. If MLE_FRONT_LENGTH is non-zero, it is recommended to set FOX_KEMPER_ML_RESTRAT_COEF=1.0.

Definition at line 39 of file MOM_mixed_layer_restrat.F90.

39 real :: front_length !< If non-zero, is the frontal-length scale used to calculate the

◆ id_mld

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_mld = -1

Diagnostic identifier.

Definition at line 70 of file MOM_mixed_layer_restrat.F90.

70 integer :: id_mld = -1

◆ id_rml

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_rml = -1

Diagnostic identifier.

Definition at line 71 of file MOM_mixed_layer_restrat.F90.

71 integer :: id_rml = -1

◆ id_udml

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_udml = -1

Diagnostic identifier.

Definition at line 72 of file MOM_mixed_layer_restrat.F90.

72 integer :: id_udml = -1

◆ id_uhml

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_uhml = -1

Diagnostic identifier.

Definition at line 68 of file MOM_mixed_layer_restrat.F90.

68 integer :: id_uhml = -1

◆ id_uml

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_uml = -1

Diagnostic identifier.

Definition at line 74 of file MOM_mixed_layer_restrat.F90.

74 integer :: id_uml = -1

◆ id_urestrat_time

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_urestrat_time = -1

Diagnostic identifier.

Definition at line 66 of file MOM_mixed_layer_restrat.F90.

66 integer :: id_urestrat_time = -1

◆ id_vdml

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_vdml = -1

Diagnostic identifier.

Definition at line 73 of file MOM_mixed_layer_restrat.F90.

73 integer :: id_vdml = -1

◆ id_vhml

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_vhml = -1

Diagnostic identifier.

Definition at line 69 of file MOM_mixed_layer_restrat.F90.

69 integer :: id_vhml = -1

◆ id_vml

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_vml = -1

Diagnostic identifier.

Definition at line 75 of file MOM_mixed_layer_restrat.F90.

75 integer :: id_vml = -1

◆ id_vrestrat_time

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_vrestrat_time = -1

Diagnostic identifier.

Definition at line 67 of file MOM_mixed_layer_restrat.F90.

67 integer :: id_vrestrat_time = -1

◆ ml_restrat_coef

real mom_mixed_layer_restrat::mixedlayer_restrat_cs::ml_restrat_coef

A non-dimensional factor by which the instability is enhanced over what would be predicted based on the resolved gradients. This increases with grid spacing^2, up to something of order 500.

Definition at line 33 of file MOM_mixed_layer_restrat.F90.

33 real :: ml_restrat_coef !< A non-dimensional factor by which the

◆ ml_restrat_coef2

real mom_mixed_layer_restrat::mixedlayer_restrat_cs::ml_restrat_coef2

As for ml_restrat_coef but using the slow filtered MLD.

Definition at line 38 of file MOM_mixed_layer_restrat.F90.

38 real :: ml_restrat_coef2 !< As for ml_restrat_coef but using the slow filtered MLD.

◆ mld_filtered

real, dimension(:,:), pointer mom_mixed_layer_restrat::mixedlayer_restrat_cs::mld_filtered => NULL()

Time-filtered MLD (H units)

Definition at line 60 of file MOM_mixed_layer_restrat.F90.

   real, dimension(:,:), pointer :: &
          mld_filtered => null(), &   !< Time-filtered MLD (H units)
          mld_filtered_slow => null() !< Slower time-filtered MLD (H units)

◆ mld_filtered_slow

real, dimension(:,:), pointer mom_mixed_layer_restrat::mixedlayer_restrat_cs::mld_filtered_slow => NULL()

Slower time-filtered MLD (H units)

Definition at line 60 of file MOM_mixed_layer_restrat.F90.

◆ mle_density_diff

real mom_mixed_layer_restrat::mixedlayer_restrat_cs::mle_density_diff

Density difference used in detecting mixed-layer depth (kg/m3).

Definition at line 48 of file MOM_mixed_layer_restrat.F90.

48 real :: mle_density_diff !< Density difference used in detecting mixed-layer

◆ mle_mld_decay_time

real mom_mixed_layer_restrat::mixedlayer_restrat_cs::mle_mld_decay_time

Time-scale to use in a running-mean when MLD is retreating (s).

Definition at line 46 of file MOM_mixed_layer_restrat.F90.

46 real :: mle_mld_decay_time !< Time-scale to use in a running-mean when MLD is retreating (s).

◆ mle_mld_decay_time2

real mom_mixed_layer_restrat::mixedlayer_restrat_cs::mle_mld_decay_time2

Time-scale to use in a running-mean when filtered MLD is retreating (s).

Definition at line 47 of file MOM_mixed_layer_restrat.F90.

47 real :: mle_mld_decay_time2 !< Time-scale to use in a running-mean when filtered MLD is retreating (s).

◆ mle_mld_stretch

real mom_mixed_layer_restrat::mixedlayer_restrat_cs::mle_mld_stretch

A scaling coefficient for stretching/shrinking the MLD used in the MLE scheme. This simply multiplies MLD wherever used.

Definition at line 53 of file MOM_mixed_layer_restrat.F90.

53 real :: mle_mld_stretch !< A scaling coefficient for stretching/shrinking the MLD

◆ mle_tail_dh

real mom_mixed_layer_restrat::mixedlayer_restrat_cs::mle_tail_dh

Fraction by which to extend the mixed-layer restratification depth used for a smoother stream function at the base of the mixed-layer.

Definition at line 50 of file MOM_mixed_layer_restrat.F90.

50 real :: mle_tail_dh !< Fraction by which to extend the mixed-layer restratification

◆ mle_use_mld_ave_bug

logical mom_mixed_layer_restrat::mixedlayer_restrat_cs::mle_use_mld_ave_bug

If true, do not account for MLD mismatch to interface positions.

Definition at line 55 of file MOM_mixed_layer_restrat.F90.

55 logical :: mle_use_mld_ave_bug !< If true, do not account for MLD mismatch to interface positions.

◆ mle_use_pbl_mld

logical mom_mixed_layer_restrat::mixedlayer_restrat_cs::mle_use_pbl_mld

If true, use the MLD provided by the PBL parameterization. if false, MLE will calculate a MLD based on a density difference based on the parameter MLE_DENSITY_DIFF.

Definition at line 43 of file MOM_mixed_layer_restrat.F90.

43 logical :: mle_use_pbl_mld !< If true, use the MLD provided by the PBL parameterization.

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

/home/adcroft/GitHub/workspace/Gaea-stats-MOM6-examples/MOM6-examples/src/MOM6/src/parameterizations/lateral/MOM_mixed_layer_restrat.F90

Detailed Description

Public variables and constants

Variables and constants

◆ debug

◆ diag

◆ front_length

◆ id_mld

◆ id_rml

◆ id_udml

◆ id_uhml

◆ id_uml

◆ id_urestrat_time

◆ id_vdml

◆ id_vhml

◆ id_vml

◆ id_vrestrat_time

◆ ml_restrat_coef

◆ ml_restrat_coef2

◆ mld_filtered

◆ mld_filtered_slow

◆ mle_density_diff

◆ mle_mld_decay_time

◆ mle_mld_decay_time2

◆ mle_mld_stretch

◆ mle_tail_dh

◆ mle_use_mld_ave_bug

◆ mle_use_pbl_mld