Detailed Description

This control structure holds parameters used by the MOM_regularize_layers module.

Definition at line 26 of file MOM_regularize_layers.F90.

Collaboration diagram for mom_regularize_layers::regularize_layers_cs:

Public variables and constants
logical	regularize_surface_layers
	If true, vertically restructure the near-surface layers when they have too much lateral variations to allow for sensible lateral barotropic transports. More...

logical	reg_sfc_detrain
	If true, allow the buffer layers to detrain into the interior as a part of the restructuring when regularize_surface_layers is true. More...

real	h_def_tol1
	The value of the relative thickness deficit at which to start modifying the structure, 0.5 by default (or a thickness ratio of 5.83). More...

real	h_def_tol2
	The value of the relative thickness deficit at which to the structure modification is in full force, now 20% of the way from h_def_tol1 to 1. More...

real	h_def_tol3
	The value of the relative thickness deficit at which to start detrainment from the buffer layers to the interior, now 30% of the way from h_def_tol1 to 1. More...

real	h_def_tol4
	The value of the relative thickness deficit at which to do detrainment from the buffer layers to the interior at full force, now 50% of the way from h_def_tol1 to 1. More...

real	hmix_min
	The minimum mixed layer thickness [H ~> m or kg m-2]. More...

type(time_type), pointer	time => NULL()
	A pointer to the ocean model's clock. More...

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

logical	debug
	If true, do more thorough checks for debugging purposes. More...

integer	id_def_rat = -1
	A diagnostic ID. More...

logical	allow_clocks_in_omp_loops
	If true, clocks can be called from inside loops that can be threaded. To run with multiple threads, set to False. More...


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Variables and constants

◆ allow_clocks_in_omp_loops

logical mom_regularize_layers::regularize_layers_cs::allow_clocks_in_omp_loops

If true, clocks can be called from inside loops that can be threaded. To run with multiple threads, set to False.

Definition at line 53 of file MOM_regularize_layers.F90.

53 logical :: allow_clocks_in_omp_loops !< If true, clocks can be called from inside loops that

◆ debug

logical mom_regularize_layers::regularize_layers_cs::debug

If true, do more thorough checks for debugging purposes.

Definition at line 50 of file MOM_regularize_layers.F90.

50 logical :: debug !< If true, do more thorough checks for debugging purposes.

◆ diag

type(diag_ctrl), pointer mom_regularize_layers::regularize_layers_cs::diag => NULL()

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

Definition at line 48 of file MOM_regularize_layers.F90.

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

◆ h_def_tol1

real mom_regularize_layers::regularize_layers_cs::h_def_tol1

The value of the relative thickness deficit at which to start modifying the structure, 0.5 by default (or a thickness ratio of 5.83).

Definition at line 34 of file MOM_regularize_layers.F90.

34 real :: h_def_tol1 !< The value of the relative thickness deficit at

◆ h_def_tol2

real mom_regularize_layers::regularize_layers_cs::h_def_tol2

The value of the relative thickness deficit at which to the structure modification is in full force, now 20% of the way from h_def_tol1 to 1.

Definition at line 37 of file MOM_regularize_layers.F90.

37 real :: h_def_tol2 !< The value of the relative thickness deficit at

◆ h_def_tol3

real mom_regularize_layers::regularize_layers_cs::h_def_tol3

The value of the relative thickness deficit at which to start detrainment from the buffer layers to the interior, now 30% of the way from h_def_tol1 to 1.

Definition at line 40 of file MOM_regularize_layers.F90.

40 real :: h_def_tol3 !< The value of the relative thickness deficit at which to start

◆ h_def_tol4

real mom_regularize_layers::regularize_layers_cs::h_def_tol4

The value of the relative thickness deficit at which to do detrainment from the buffer layers to the interior at full force, now 50% of the way from h_def_tol1 to 1.

Definition at line 43 of file MOM_regularize_layers.F90.

43 real :: h_def_tol4 !< The value of the relative thickness deficit at which to do

◆ hmix_min

real mom_regularize_layers::regularize_layers_cs::hmix_min

The minimum mixed layer thickness [H ~> m or kg m-2].

Definition at line 46 of file MOM_regularize_layers.F90.

46 real :: Hmix_min !< The minimum mixed layer thickness [H ~> m or kg m-2].

◆ id_def_rat

integer mom_regularize_layers::regularize_layers_cs::id_def_rat = -1

A diagnostic ID.

Definition at line 52 of file MOM_regularize_layers.F90.

52 integer :: id_def_rat = -1 !< A diagnostic ID

◆ id_def_rat_2

integer mom_regularize_layers::regularize_layers_cs::id_def_rat_2 = -1

Diagnostic IDs.

Definition at line 57 of file MOM_regularize_layers.F90.

57 integer :: id_def_rat_2 = -1, id_def_rat_3 = -1

◆ id_def_rat_3

integer mom_regularize_layers::regularize_layers_cs::id_def_rat_3 = -1

Diagnostic IDs.

Definition at line 57 of file MOM_regularize_layers.F90.

◆ id_def_rat_u

integer mom_regularize_layers::regularize_layers_cs::id_def_rat_u = -1

Diagnostic IDs.

Definition at line 58 of file MOM_regularize_layers.F90.

58 integer :: id_def_rat_u = -1, id_def_rat_v = -1

◆ id_def_rat_u_1b

integer mom_regularize_layers::regularize_layers_cs::id_def_rat_u_1b = -1

Diagnostic IDs.

Definition at line 60 of file MOM_regularize_layers.F90.

60 integer :: id_def_rat_u_1b = -1, id_def_rat_v_1b = -1

◆ id_def_rat_u_2

integer mom_regularize_layers::regularize_layers_cs::id_def_rat_u_2 = -1

Diagnostic IDs.

Definition at line 61 of file MOM_regularize_layers.F90.

61 integer :: id_def_rat_u_2 = -1, id_def_rat_u_2b = -1

◆ id_def_rat_u_2b

integer mom_regularize_layers::regularize_layers_cs::id_def_rat_u_2b = -1

Diagnostic IDs.

Definition at line 61 of file MOM_regularize_layers.F90.

◆ id_def_rat_u_3

integer mom_regularize_layers::regularize_layers_cs::id_def_rat_u_3 = -1

Diagnostic IDs.

Definition at line 63 of file MOM_regularize_layers.F90.

63 integer :: id_def_rat_u_3 = -1, id_def_rat_u_3b = -1

◆ id_def_rat_u_3b

integer mom_regularize_layers::regularize_layers_cs::id_def_rat_u_3b = -1

Diagnostic IDs.

Definition at line 63 of file MOM_regularize_layers.F90.

◆ id_def_rat_v

integer mom_regularize_layers::regularize_layers_cs::id_def_rat_v = -1

Diagnostic IDs.

Definition at line 58 of file MOM_regularize_layers.F90.

◆ id_def_rat_v_1b

integer mom_regularize_layers::regularize_layers_cs::id_def_rat_v_1b = -1

Diagnostic IDs.

Definition at line 60 of file MOM_regularize_layers.F90.

◆ id_def_rat_v_2

integer mom_regularize_layers::regularize_layers_cs::id_def_rat_v_2 = -1

Diagnostic IDs.

Definition at line 62 of file MOM_regularize_layers.F90.

62 integer :: id_def_rat_v_2 = -1, id_def_rat_v_2b = -1

◆ id_def_rat_v_2b

integer mom_regularize_layers::regularize_layers_cs::id_def_rat_v_2b = -1

Diagnostic IDs.

Definition at line 62 of file MOM_regularize_layers.F90.

◆ id_def_rat_v_3

integer mom_regularize_layers::regularize_layers_cs::id_def_rat_v_3 = -1

Diagnostic IDs.

Definition at line 64 of file MOM_regularize_layers.F90.

64 integer :: id_def_rat_v_3 = -1, id_def_rat_v_3b = -1

◆ id_def_rat_v_3b

integer mom_regularize_layers::regularize_layers_cs::id_def_rat_v_3b = -1

Diagnostic IDs.

Definition at line 64 of file MOM_regularize_layers.F90.

◆ id_e1

integer mom_regularize_layers::regularize_layers_cs::id_e1 = -1

Diagnostic IDs.

Definition at line 59 of file MOM_regularize_layers.F90.

59 integer :: id_e1 = -1, id_e2 = -1, id_e3 = -1

◆ id_e2

integer mom_regularize_layers::regularize_layers_cs::id_e2 = -1

Diagnostic IDs.

Definition at line 59 of file MOM_regularize_layers.F90.

◆ id_e3

integer mom_regularize_layers::regularize_layers_cs::id_e3 = -1

Diagnostic IDs.

Definition at line 59 of file MOM_regularize_layers.F90.

◆ reg_sfc_detrain

logical mom_regularize_layers::regularize_layers_cs::reg_sfc_detrain

If true, allow the buffer layers to detrain into the interior as a part of the restructuring when regularize_surface_layers is true.

Definition at line 31 of file MOM_regularize_layers.F90.

31 logical :: reg_sfc_detrain !< If true, allow the buffer layers to detrain into the

◆ regularize_surface_layers

logical mom_regularize_layers::regularize_layers_cs::regularize_surface_layers

If true, vertically restructure the near-surface layers when they have too much lateral variations to allow for sensible lateral barotropic transports.

Definition at line 27 of file MOM_regularize_layers.F90.

27 logical :: regularize_surface_layers !< If true, vertically restructure the

◆ time

type(time_type), pointer mom_regularize_layers::regularize_layers_cs::time => NULL()

A pointer to the ocean model's clock.

Definition at line 47 of file MOM_regularize_layers.F90.

47 type(time_type), pointer :: Time => null() !< A pointer to the ocean model's clock.

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/vertical/MOM_regularize_layers.F90

Detailed Description

Public variables and constants

Variables and constants

◆ allow_clocks_in_omp_loops

◆ debug

◆ diag

◆ h_def_tol1

◆ h_def_tol2

◆ h_def_tol3

◆ h_def_tol4

◆ hmix_min

◆ id_def_rat

◆ id_def_rat_2

◆ id_def_rat_3

◆ id_def_rat_u

◆ id_def_rat_u_1b

◆ id_def_rat_u_2

◆ id_def_rat_u_2b

◆ id_def_rat_u_3

◆ id_def_rat_u_3b

◆ id_def_rat_v

◆ id_def_rat_v_1b

◆ id_def_rat_v_2

◆ id_def_rat_v_2b

◆ id_def_rat_v_3

◆ id_def_rat_v_3b

◆ id_e1

◆ id_e2

◆ id_e3

◆ reg_sfc_detrain

◆ regularize_surface_layers

◆ time