MOM6
mom_continuity_ppm::continuity_ppm_cs Type Reference

Detailed Description

Control structure for mom_continuity_ppm.

Definition at line 28 of file MOM_continuity_PPM.F90.

Collaboration diagram for mom_continuity_ppm::continuity_ppm_cs:
[legend]

Public variables and constants

type(diag_ctrl), pointer diag
 Diagnostics control structure. More...
 
logical upwind_1st
 If true, use a first-order upwind scheme. More...
 
logical monotonic
 If true, use the Colella & Woodward monotonic limiter; otherwise use a simple positive definite limiter. More...
 
logical simple_2nd
 If true, use a simple second order (arithmetic mean) interpolation of the edge values instead of the higher order interpolation. More...
 
real tol_eta
 The tolerance for free-surface height discrepancies between the barotropic solution and the sum of the layer thicknesses [H ~> m or kg m-2]. More...
 
real tol_vel
 The tolerance for barotropic velocity discrepancies between the barotropic solution and the sum of the layer thicknesses [L T-1 ~> m s-1]. More...
 
real tol_eta_aux
 The tolerance for free-surface height discrepancies between the barotropic solution and the sum of the layer thicknesses when calculating the auxiliary corrected velocities [H ~> m or kg m-2]. More...
 
real cfl_limit_adjust
 The maximum CFL of the adjusted velocities [nondim]. More...
 
logical aggress_adjust
 If true, allow the adjusted velocities to have a relative CFL change up to 0.5. False by default. More...
 
logical vol_cfl
 If true, use the ratio of the open face lengths to the tracer cell areas when estimating CFL numbers. Without aggress_adjust, the default is false; it is always true with. More...
 
logical better_iter
 If true, stop corrective iterations using a velocity-based criterion and only stop if the iteration is better than all predecessors. More...
 
logical use_visc_rem_max
 If true, use more appropriate limiting bounds for corrections in strongly viscous columns. More...
 
logical marginal_faces
 If true, use the marginal face areas from the continuity solver for use as the weights in the barotropic solver. Otherwise use the transport averaged areas. More...
 

Variables and constants

◆ aggress_adjust

logical mom_continuity_ppm::continuity_ppm_cs::aggress_adjust

If true, allow the adjusted velocities to have a relative CFL change up to 0.5. False by default.

Definition at line 48 of file MOM_continuity_PPM.F90.

48  logical :: aggress_adjust !< If true, allow the adjusted velocities to have a

◆ better_iter

logical mom_continuity_ppm::continuity_ppm_cs::better_iter

If true, stop corrective iterations using a velocity-based criterion and only stop if the iteration is better than all predecessors.

Definition at line 54 of file MOM_continuity_PPM.F90.

54  logical :: better_iter !< If true, stop corrective iterations using a

◆ cfl_limit_adjust

real mom_continuity_ppm::continuity_ppm_cs::cfl_limit_adjust

The maximum CFL of the adjusted velocities [nondim].

Definition at line 47 of file MOM_continuity_PPM.F90.

47  real :: CFL_limit_adjust !< The maximum CFL of the adjusted velocities [nondim]

◆ diag

type(diag_ctrl), pointer mom_continuity_ppm::continuity_ppm_cs::diag

Diagnostics control structure.

Definition at line 29 of file MOM_continuity_PPM.F90.

29  type(diag_ctrl), pointer :: diag !< Diagnostics control structure.

◆ marginal_faces

logical mom_continuity_ppm::continuity_ppm_cs::marginal_faces

If true, use the marginal face areas from the continuity solver for use as the weights in the barotropic solver. Otherwise use the transport averaged areas.

Definition at line 59 of file MOM_continuity_PPM.F90.

59  logical :: marginal_faces !< If true, use the marginal face areas from the

◆ monotonic

logical mom_continuity_ppm::continuity_ppm_cs::monotonic

If true, use the Colella & Woodward monotonic limiter; otherwise use a simple positive definite limiter.

Definition at line 31 of file MOM_continuity_PPM.F90.

31  logical :: monotonic !< If true, use the Colella & Woodward monotonic

◆ simple_2nd

logical mom_continuity_ppm::continuity_ppm_cs::simple_2nd

If true, use a simple second order (arithmetic mean) interpolation of the edge values instead of the higher order interpolation.

Definition at line 34 of file MOM_continuity_PPM.F90.

34  logical :: simple_2nd !< If true, use a simple second order (arithmetic

◆ tol_eta

real mom_continuity_ppm::continuity_ppm_cs::tol_eta

The tolerance for free-surface height discrepancies between the barotropic solution and the sum of the layer thicknesses [H ~> m or kg m-2].

Definition at line 37 of file MOM_continuity_PPM.F90.

37  real :: tol_eta !< The tolerance for free-surface height

◆ tol_eta_aux

real mom_continuity_ppm::continuity_ppm_cs::tol_eta_aux

The tolerance for free-surface height discrepancies between the barotropic solution and the sum of the layer thicknesses when calculating the auxiliary corrected velocities [H ~> m or kg m-2].

Definition at line 43 of file MOM_continuity_PPM.F90.

43  real :: tol_eta_aux !< The tolerance for free-surface height

◆ tol_vel

real mom_continuity_ppm::continuity_ppm_cs::tol_vel

The tolerance for barotropic velocity discrepancies between the barotropic solution and the sum of the layer thicknesses [L T-1 ~> m s-1].

Definition at line 40 of file MOM_continuity_PPM.F90.

40  real :: tol_vel !< The tolerance for barotropic velocity

◆ upwind_1st

logical mom_continuity_ppm::continuity_ppm_cs::upwind_1st

If true, use a first-order upwind scheme.

Definition at line 30 of file MOM_continuity_PPM.F90.

30  logical :: upwind_1st !< If true, use a first-order upwind scheme.

◆ use_visc_rem_max

logical mom_continuity_ppm::continuity_ppm_cs::use_visc_rem_max

If true, use more appropriate limiting bounds for corrections in strongly viscous columns.

Definition at line 57 of file MOM_continuity_PPM.F90.

57  logical :: use_visc_rem_max !< If true, use more appropriate limiting bounds

◆ vol_cfl

logical mom_continuity_ppm::continuity_ppm_cs::vol_cfl

If true, use the ratio of the open face lengths to the tracer cell areas when estimating CFL numbers. Without aggress_adjust, the default is false; it is always true with.

Definition at line 50 of file MOM_continuity_PPM.F90.

50  logical :: vol_CFL !< If true, use the ratio of the open face lengths

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