MOM6
mom_mixed_layer_restrat::mixedlayer_restrat_cs Type Reference

Detailed Description

Control structure for mom_mixed_layer_restrat.

Definition at line 38 of file MOM_mixed_layer_restrat.F90.

Collaboration diagram for mom_mixed_layer_restrat::mixedlayer_restrat_cs:
[legend]

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 [nondim]. 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 [nondim]. More...
 
real front_length
 If non-zero, is the frontal-length scale [L ~> m] 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 [T ~> s]. More...
 
real mle_mld_decay_time2
 Time-scale to use in a running-mean when filtered MLD is retreating [T ~> s]. More...
 
real mle_density_diff
 Density difference used in detecting mixed-layer depth [R ~> kg m-3]. 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 [nondim]. More...
 
real mle_mld_stretch
 A scaling coefficient for stretching/shrinking the MLD used in the MLE scheme [nondim]. 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 ~> m or kg m-2]. More...
 
real, dimension(:,:), pointer mld_filtered_slow => NULL()
 Slower time-filtered MLD [H ~> m or kg m-2]. 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 60 of file MOM_mixed_layer_restrat.F90.

60  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 61 of file MOM_mixed_layer_restrat.F90.

61  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 [L ~> m] 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 44 of file MOM_mixed_layer_restrat.F90.

44  real :: front_length !< If non-zero, is the frontal-length scale [L ~> m] used to calculate the

◆ id_mld

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_mld = -1

Diagnostic identifier.

Definition at line 74 of file MOM_mixed_layer_restrat.F90.

74  integer :: id_MLD = -1

◆ id_rml

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_rml = -1

Diagnostic identifier.

Definition at line 75 of file MOM_mixed_layer_restrat.F90.

75  integer :: id_Rml = -1

◆ id_udml

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_udml = -1

Diagnostic identifier.

Definition at line 76 of file MOM_mixed_layer_restrat.F90.

76  integer :: id_uDml = -1

◆ id_uhml

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_uhml = -1

Diagnostic identifier.

Definition at line 72 of file MOM_mixed_layer_restrat.F90.

72  integer :: id_uhml = -1

◆ id_uml

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_uml = -1

Diagnostic identifier.

Definition at line 78 of file MOM_mixed_layer_restrat.F90.

78  integer :: id_uml = -1

◆ id_urestrat_time

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_urestrat_time = -1

Diagnostic identifier.

Definition at line 70 of file MOM_mixed_layer_restrat.F90.

70  integer :: id_urestrat_time = -1

◆ id_vdml

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_vdml = -1

Diagnostic identifier.

Definition at line 77 of file MOM_mixed_layer_restrat.F90.

77  integer :: id_vDml = -1

◆ id_vhml

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_vhml = -1

Diagnostic identifier.

Definition at line 73 of file MOM_mixed_layer_restrat.F90.

73  integer :: id_vhml = -1

◆ id_vml

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_vml = -1

Diagnostic identifier.

Definition at line 79 of file MOM_mixed_layer_restrat.F90.

79  integer :: id_vml = -1

◆ id_vrestrat_time

integer mom_mixed_layer_restrat::mixedlayer_restrat_cs::id_vrestrat_time = -1

Diagnostic identifier.

Definition at line 71 of file MOM_mixed_layer_restrat.F90.

71  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 [nondim]. This increases with grid spacing^2, up to something of order 500.

Definition at line 39 of file MOM_mixed_layer_restrat.F90.

39  real :: ml_restrat_coef !< A non-dimensional factor by which the instability is enhanced

◆ 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 [nondim].

Definition at line 43 of file MOM_mixed_layer_restrat.F90.

43  real :: ml_restrat_coef2 !< As for ml_restrat_coef but using the slow filtered MLD [nondim].

◆ mld_filtered

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

Time-filtered MLD [H ~> m or kg m-2].

Definition at line 64 of file MOM_mixed_layer_restrat.F90.

64  real, dimension(:,:), pointer :: &
65  MLD_filtered => null(), & !< Time-filtered MLD [H ~> m or kg m-2]
66  mld_filtered_slow => null() !< Slower time-filtered MLD [H ~> m or kg m-2]

◆ mld_filtered_slow

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

Slower time-filtered MLD [H ~> m or kg m-2].

Definition at line 64 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 [R ~> kg m-3].

Definition at line 53 of file MOM_mixed_layer_restrat.F90.

53  real :: MLE_density_diff !< Density difference used in detecting mixed-layer depth [R ~> kg m-3].

◆ 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 [T ~> s].

Definition at line 51 of file MOM_mixed_layer_restrat.F90.

51  real :: MLE_MLD_decay_time !< Time-scale to use in a running-mean when MLD is retreating [T ~> 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 [T ~> s].

Definition at line 52 of file MOM_mixed_layer_restrat.F90.

52  real :: MLE_MLD_decay_time2 !< Time-scale to use in a running-mean when filtered MLD is retreating [T ~> 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 [nondim]. This simply multiplies MLD wherever used.

Definition at line 57 of file MOM_mixed_layer_restrat.F90.

57  real :: MLE_MLD_stretch !< A scaling coefficient for stretching/shrinking the MLD used in

◆ 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 [nondim].

Definition at line 54 of file MOM_mixed_layer_restrat.F90.

54  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 59 of file MOM_mixed_layer_restrat.F90.

59  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 48 of file MOM_mixed_layer_restrat.F90.

48  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: