Detailed Description

The ocntrol structure for along-layer and epineutral tracer diffusion.

Definition at line 40 of file MOM_tracer_hor_diff.F90.

Collaboration diagram for mom_tracer_hor_diff::tracer_hor_diff_cs:

Public variables and constants
real	khtr
	The along-isopycnal tracer diffusivity [L2 T-1 ~> m2 s-1]. More...

real	khtr_slope_cff
	The non-dimensional coefficient in KhTr formula [nondim]. More...

real	khtr_min
	Minimum along-isopycnal tracer diffusivity [L2 T-1 ~> m2 s-1]. More...

real	khtr_max
	Maximum along-isopycnal tracer diffusivity [L2 T-1 ~> m2 s-1]. More...

real	khtr_passivity_coeff
	Passivity coefficient that scales Rd/dx (default = 0) where passivity is the ratio between along-isopycnal tracer mixing and thickness mixing [nondim]. More...

real	khtr_passivity_min
	Passivity minimum (default = 1/2) [nondim]. More...

real	ml_khtr_scale
	With Diffuse_ML_interior, the ratio of the truly horizontal diffusivity in the mixed layer to the epipycnal diffusivity [nondim]. More...

real	max_diff_cfl
	If positive, locally limit the along-isopycnal tracer diffusivity to keep the diffusive CFL locally at or below this value [nondim]. More...

logical	diffuse_ml_interior
	If true, diffuse along isopycnals between the mixed layer and the interior. More...

logical	check_diffusive_cfl
	If true, automatically iterate the diffusion to ensure that the diffusive equivalent of the CFL limit is not violated. More...

logical	use_neutral_diffusion
	If true, use the neutral_diffusion module from within tracer_hor_diff. More...

logical	use_lateral_boundary_diffusion
	If true, use the lateral_boundary_diffusion module from within tracer_hor_diff. More...

logical	recalc_neutral_surf
	If true, recalculate the neutral surfaces if CFL has been exceeded. More...

type(neutral_diffusion_cs), pointer	neutral_diffusion_csp => NULL()
	Control structure for neutral diffusion. More...

type(lateral_boundary_diffusion_cs), pointer	lateral_boundary_diffusion_csp => NULL()
	Control structure for lateral boundary mixing. More...

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

logical	debug
	If true, write verbose checksums for debugging purposes. More...

logical	show_call_tree
	Display the call tree while running. Set by VERBOSITY level. More...

logical	first_call = .true.
	This is true until after the first call. More...


integer	id_khtr_u = -1
	Diagnostic IDs. More...

integer	id_khtr_v = -1
	Diagnostic IDs. More...

integer	id_khtr_h = -1
	Diagnostic IDs. More...

integer	id_cfl = -1
	Diagnostic IDs. More...

integer	id_khdt_x = -1
	Diagnostic IDs. More...

integer	id_khdt_y = -1
	Diagnostic IDs. More...

type(group_pass_type)	pass_t
	For group halo pass, used in both tracer_hordiff and tracer_epipycnal_ML_diff. More...

Variables and constants

◆ check_diffusive_cfl

logical mom_tracer_hor_diff::tracer_hor_diff_cs::check_diffusive_cfl

If true, automatically iterate the diffusion to ensure that the diffusive equivalent of the CFL limit is not violated.

Definition at line 57 of file MOM_tracer_hor_diff.F90.

57 logical :: check_diffusive_CFL !< If true, automatically iterate the diffusion

◆ debug

logical mom_tracer_hor_diff::tracer_hor_diff_cs::debug

If true, write verbose checksums for debugging purposes.

Definition at line 71 of file MOM_tracer_hor_diff.F90.

71 logical :: debug !< If true, write verbose checksums for debugging purposes.

◆ diag

type(diag_ctrl), pointer mom_tracer_hor_diff::tracer_hor_diff_cs::diag => NULL()

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

Definition at line 69 of file MOM_tracer_hor_diff.F90.

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

◆ diffuse_ml_interior

logical mom_tracer_hor_diff::tracer_hor_diff_cs::diffuse_ml_interior

If true, diffuse along isopycnals between the mixed layer and the interior.

Definition at line 55 of file MOM_tracer_hor_diff.F90.

55 logical :: Diffuse_ML_interior !< If true, diffuse along isopycnals between

◆ first_call

logical mom_tracer_hor_diff::tracer_hor_diff_cs::first_call = .true.

This is true until after the first call.

Definition at line 73 of file MOM_tracer_hor_diff.F90.

73 logical :: first_call = .true. !< This is true until after the first call

◆ id_cfl

integer mom_tracer_hor_diff::tracer_hor_diff_cs::id_cfl = -1

Diagnostic IDs.

Definition at line 78 of file MOM_tracer_hor_diff.F90.

78 integer :: id_CFL = -1

◆ id_khdt_x

integer mom_tracer_hor_diff::tracer_hor_diff_cs::id_khdt_x = -1

Diagnostic IDs.

Definition at line 79 of file MOM_tracer_hor_diff.F90.

79 integer :: id_khdt_x = -1

◆ id_khdt_y

integer mom_tracer_hor_diff::tracer_hor_diff_cs::id_khdt_y = -1

Diagnostic IDs.

Definition at line 80 of file MOM_tracer_hor_diff.F90.

80 integer :: id_khdt_y = -1

◆ id_khtr_h

integer mom_tracer_hor_diff::tracer_hor_diff_cs::id_khtr_h = -1

Diagnostic IDs.

Definition at line 77 of file MOM_tracer_hor_diff.F90.

77 integer :: id_KhTr_h = -1

◆ id_khtr_u

integer mom_tracer_hor_diff::tracer_hor_diff_cs::id_khtr_u = -1

Diagnostic IDs.

Definition at line 75 of file MOM_tracer_hor_diff.F90.

75 integer :: id_KhTr_u = -1

◆ id_khtr_v

integer mom_tracer_hor_diff::tracer_hor_diff_cs::id_khtr_v = -1

Diagnostic IDs.

Definition at line 76 of file MOM_tracer_hor_diff.F90.

76 integer :: id_KhTr_v = -1

◆ khtr

real mom_tracer_hor_diff::tracer_hor_diff_cs::khtr

The along-isopycnal tracer diffusivity [L2 T-1 ~> m2 s-1].

Definition at line 41 of file MOM_tracer_hor_diff.F90.

41 real :: KhTr !< The along-isopycnal tracer diffusivity [L2 T-1 ~> m2 s-1].

◆ khtr_max

real mom_tracer_hor_diff::tracer_hor_diff_cs::khtr_max

Maximum along-isopycnal tracer diffusivity [L2 T-1 ~> m2 s-1].

Definition at line 44 of file MOM_tracer_hor_diff.F90.

44 real :: KhTr_max !< Maximum along-isopycnal tracer diffusivity [L2 T-1 ~> m2 s-1].

◆ khtr_min

real mom_tracer_hor_diff::tracer_hor_diff_cs::khtr_min

Minimum along-isopycnal tracer diffusivity [L2 T-1 ~> m2 s-1].

Definition at line 43 of file MOM_tracer_hor_diff.F90.

43 real :: KhTr_min !< Minimum along-isopycnal tracer diffusivity [L2 T-1 ~> m2 s-1].

◆ khtr_passivity_coeff

real mom_tracer_hor_diff::tracer_hor_diff_cs::khtr_passivity_coeff

Passivity coefficient that scales Rd/dx (default = 0) where passivity is the ratio between along-isopycnal tracer mixing and thickness mixing [nondim].

Definition at line 45 of file MOM_tracer_hor_diff.F90.

45 real :: KhTr_passivity_coeff !< Passivity coefficient that scales Rd/dx (default = 0)

◆ khtr_passivity_min

real mom_tracer_hor_diff::tracer_hor_diff_cs::khtr_passivity_min

Passivity minimum (default = 1/2) [nondim].

Definition at line 48 of file MOM_tracer_hor_diff.F90.

48 real :: KhTr_passivity_min !< Passivity minimum (default = 1/2) [nondim]

◆ khtr_slope_cff

real mom_tracer_hor_diff::tracer_hor_diff_cs::khtr_slope_cff

The non-dimensional coefficient in KhTr formula [nondim].

Definition at line 42 of file MOM_tracer_hor_diff.F90.

42 real :: KhTr_Slope_Cff !< The non-dimensional coefficient in KhTr formula [nondim]

◆ lateral_boundary_diffusion_csp

type(lateral_boundary_diffusion_cs), pointer mom_tracer_hor_diff::tracer_hor_diff_cs::lateral_boundary_diffusion_csp => NULL()

Control structure for lateral boundary mixing.

Definition at line 67 of file MOM_tracer_hor_diff.F90.

67 type(lateral_boundary_diffusion_CS), pointer :: lateral_boundary_diffusion_CSp => null() !< Control structure for

◆ max_diff_cfl

real mom_tracer_hor_diff::tracer_hor_diff_cs::max_diff_cfl

If positive, locally limit the along-isopycnal tracer diffusivity to keep the diffusive CFL locally at or below this value [nondim].

Definition at line 52 of file MOM_tracer_hor_diff.F90.

52 real :: max_diff_CFL !< If positive, locally limit the along-isopycnal

◆ ml_khtr_scale

real mom_tracer_hor_diff::tracer_hor_diff_cs::ml_khtr_scale

With Diffuse_ML_interior, the ratio of the truly horizontal diffusivity in the mixed layer to the epipycnal diffusivity [nondim].

Definition at line 49 of file MOM_tracer_hor_diff.F90.

49 real :: ML_KhTR_scale !< With Diffuse_ML_interior, the ratio of the

◆ neutral_diffusion_csp

type(neutral_diffusion_cs), pointer mom_tracer_hor_diff::tracer_hor_diff_cs::neutral_diffusion_csp => NULL()

Control structure for neutral diffusion.

Definition at line 66 of file MOM_tracer_hor_diff.F90.

66 type(neutral_diffusion_CS), pointer :: neutral_diffusion_CSp => null() !< Control structure for neutral diffusion.

◆ pass_t

type(group_pass_type) mom_tracer_hor_diff::tracer_hor_diff_cs::pass_t

For group halo pass, used in both tracer_hordiff and tracer_epipycnal_ML_diff.

Definition at line 83 of file MOM_tracer_hor_diff.F90.

83 type(group_pass_type) :: pass_t !< For group halo pass, used in both

◆ recalc_neutral_surf

logical mom_tracer_hor_diff::tracer_hor_diff_cs::recalc_neutral_surf

If true, recalculate the neutral surfaces if CFL has been exceeded.

Definition at line 64 of file MOM_tracer_hor_diff.F90.

64 logical :: recalc_neutral_surf !< If true, recalculate the neutral surfaces if CFL has been

◆ show_call_tree

logical mom_tracer_hor_diff::tracer_hor_diff_cs::show_call_tree

Display the call tree while running. Set by VERBOSITY level.

Definition at line 72 of file MOM_tracer_hor_diff.F90.

72 logical :: show_call_tree !< Display the call tree while running. Set by VERBOSITY level.

◆ use_lateral_boundary_diffusion

logical mom_tracer_hor_diff::tracer_hor_diff_cs::use_lateral_boundary_diffusion

If true, use the lateral_boundary_diffusion module from within tracer_hor_diff.

Definition at line 62 of file MOM_tracer_hor_diff.F90.

62 logical :: use_lateral_boundary_diffusion !< If true, use the lateral_boundary_diffusion module from within

◆ use_neutral_diffusion

logical mom_tracer_hor_diff::tracer_hor_diff_cs::use_neutral_diffusion

If true, use the neutral_diffusion module from within tracer_hor_diff.

Definition at line 60 of file MOM_tracer_hor_diff.F90.

60 logical :: use_neutral_diffusion !< If true, use the neutral_diffusion module from within

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/tracer/MOM_tracer_hor_diff.F90

Detailed Description

Public variables and constants

Variables and constants

◆ check_diffusive_cfl

◆ debug

◆ diag

◆ diffuse_ml_interior

◆ first_call

◆ id_cfl

◆ id_khdt_x

◆ id_khdt_y

◆ id_khtr_h

◆ id_khtr_u

◆ id_khtr_v

◆ khtr

◆ khtr_max

◆ khtr_min

◆ khtr_passivity_coeff

◆ khtr_passivity_min

◆ khtr_slope_cff

◆ lateral_boundary_diffusion_csp

◆ max_diff_cfl

◆ ml_khtr_scale

◆ neutral_diffusion_csp

◆ pass_t

◆ recalc_neutral_surf

◆ show_call_tree

◆ use_lateral_boundary_diffusion

◆ use_neutral_diffusion