mom_coriolisadv module reference

Accelerations due to the Coriolis force and momentum advection.

Data Types

coriolisadv_cs

Control structure for mom_coriolisadv().

Functions/Subroutines

`coradcalc()`	Calculates the Coriolis and momentum advection contributions to the acceleration.
`gradke()`	Calculates the acceleration due to the gradient of kinetic energy in one layer.
`up3_reconstruction()`	Reconstruct the scalar (e.g., pv, vorticity) onto point i-1/2 using a third-order upwind scheme.
`up3_koren_limiter_reconstruction()`	Reconstruct the scalar (e.g., PV, vorticity) onto point i-1/2 using a third-order upwind scheme with the Koren flux limiter.
`fac_fn()`	Compute the factor for the WENO weights.
`weno_three_h_weight_reconstruction()`	Reconstruct the tracer (e.g., PV, vorticity) onto the point i-1/2 using a third-order WENO scheme This reconstruction is thickness-weighted.
`weno_three_weight()`	Compute the smoothness indicator for the two-point stencil of the third-order WENO scheme.
`weno_three_reconstruction_0()`	Reconstruction in the second upwind stencil of the third-order WENO scheme.
`weno_three_reconstruction_1()`	Reconstruction in the first upwind stencil for third-order WENO scheme.
`weno_five_h_weight_reconstruction()`	Reconstruct the tracer (e.g., PV, vorticity) onto point i-1/2 using a fifth-order WENO scheme The reconstruction is weighted by the thickness.
`weno_five_weight_0()`	Compute the smoothness indicator for the third upwind stencil of the fifth-order WENO scheme.
`weno_five_weight_1()`	Compute the smoothness indicator for the second upwind stencil of the fifth-order WENO scheme.
`weno_five_weight_2()`	Compute the smoothness indicator for the first upwind stencil of the fifth-order WENO scheme.
`weno_five_reconstruction_0()`	Reconstruction in the third upwind stencil of the fifth-order WENO scheme.
`weno_five_reconstruction_1()`	Reconstruction in the second upwind stencil of the fifth-order WENO scheme.
`weno_five_reconstruction_2()`	Reconstruction in the first upwind stencil of the fifth-order WENO scheme.
`weno_seven_h_weight_reconstruction()`	Reconstruct the tracer (e.g., PV, vorticity) onto point i-1/2 using a seventh-order WENO scheme This reconstruction computes a thickness weighted average of PV.
`weno_seven_weight_0()`	Compute the smoothness indicator for the fourth upwind stencil of the seventh-order WENO scheme.
`weno_seven_weight_1()`	Compute the smoothness indicator for the third upwind stencil of the seventh-order WENO scheme.
`weno_seven_weight_2()`	Compute the smoothness indicator for the second upwind stencil of the seventh-order WENO scheme.
`weno_seven_weight_3()`	Compute smoothness indicator for the first upwind stencil of the seventh-order WENO scheme.
`weno_seven_reconstruction_0()`	Reconstruction in the fourth upwind stencil for seventh-order WENO scheme.
`weno_seven_reconstruction_1()`	Reconstruction in the third upwind stencil for seventh-order WENO scheme.
`weno_seven_reconstruction_2()`	Reconstruction in the second upwind stencil for seventh-order WENO scheme.
`weno_seven_reconstruction_3()`	Reconstruction in the first upwind stencil for seventh-order WENO scheme.
`coriolisadv_stencil()`
`coriolisadv_init()`	Initializes the control structure for MOM_CoriolisAdv.
`coriolisadv_end()`	Destructor for `coriolisadv_cs()`.

Detailed Description

This file contains the subroutine that calculates the time derivatives of the velocities due to Coriolis acceleration and momentum advection. This subroutine uses either a vorticity advection scheme from Arakawa and Hsu, Mon. Wea. Rev. 1990, or Sadourny’s (JAS 1975) energy conserving scheme. Both have been modified to use general orthogonal coordinates as described in Arakawa and Lamb, Mon. Wea. Rev. 1981. Both schemes are second order accurate, and allow for vanishingly small layer thicknesses. The Arakawa and Hsu scheme globally conserves both total energy and potential enstrophy in the limit of nondivergent flow. Sadourny’s energy conserving scheme conserves energy if the flow is nondivergent or centered difference thickness fluxes are used.

A small fragment of the grid is shown below:

j+1  x ^ x ^ x   At x:  q, CoriolisBu
j+1  > o > o >   At ^:  v, CAv, vh
j    x ^ x ^ x   At >:  u, CAu, uh, a, b, c, d
j    > o > o >   At o:  h, KE
j-1  x ^ x ^ x
    i-1  i  i+1  At x & ^:
       i  i+1    At > & o:

The boundaries always run through q grid points (x).

Type Documentation

type mom_coriolisadv/coriolisadv_cs

Control structure for mom_coriolisadv(). .

Type fields:

% id_rv :: integer Diagnostic IDs.
% id_pv :: integer Diagnostic IDs.
% id_gkeu :: integer Diagnostic IDs.
% id_gkev :: integer Diagnostic IDs.
% id_rvxu :: integer Diagnostic IDs.
% id_rvxv :: integer Diagnostic IDs.
% id_hf_gkeu_2d :: integer Diagnostic IDs.
% id_hf_gkev_2d :: integer Diagnostic IDs.
% id_intz_gkeu_2d :: integer Diagnostic IDs.
% id_intz_gkev_2d :: integer Diagnostic IDs.
% id_hf_rvxu_2d :: integer Diagnostic IDs.
% id_hf_rvxv_2d :: integer Diagnostic IDs.
% id_h_gkeu :: integer Diagnostic IDs.
% id_h_gkev :: integer Diagnostic IDs.
% id_h_rvxu :: integer Diagnostic IDs.
% id_h_rvxv :: integer Diagnostic IDs.
% id_intz_rvxu_2d :: integer Diagnostic IDs.
% id_intz_rvxv_2d :: integer Diagnostic IDs.
% id_caus :: integer Diagnostic IDs.
% id_cavs :: integer Diagnostic IDs.
% initialized :: logical True if this control structure has been initialized.
% coriolis_scheme :: integer Selects the discretization for the Coriolis terms. Valid values are:
% ke_scheme :: integer KE_SCHEME selects the discretization for the kinetic energy. Valid values are: KE_ARAKAWA, KE_SIMPLE_GUDONOV, KE_GUDONOV.
% ke_use_limiter :: logical If true, use the Koren limiter for KE_UP3 scheme.
% pv_adv_scheme :: integer PV_ADV_SCHEME selects the discretization for PV advection Valid values are:
% f_eff_max_blend :: real The factor by which the maximum effective Coriolis acceleration from any point can be increased when blending different discretizations with the ARAKAWA_LAMB_BLEND Coriolis scheme [nondim]. This must be greater than 2.0, and is 4.0 by default.
% wt_lin_blend :: real A weighting value beyond which the blending between Sadourny and Arakawa & Hsu goes linearly to 0 [nondim]. This must be between 1 and 1e-15, often 1/8.
% no_slip :: logical If true, no slip boundary conditions are used. Otherwise free slip boundary conditions are assumed. The implementation of the free slip boundary conditions on a C-grid is much cleaner than the no slip boundary conditions. The use of free slip b.c.s is strongly encouraged. The no slip b.c.s are not implemented with the biharmonic viscosity.
% bound_coriolis :: logical If true, the Coriolis terms at u points are bounded by the four estimates of (f+rv)v from the four neighboring v points, and similarly at v points. This option would have no effect on the SADOURNY75_ENERGY scheme if it were possible to use centered difference thickness fluxes.
% coriolis_en_dis :: logical If CORIOLIS_EN_DIS is defined, two estimates of the thickness fluxes are used to estimate the Coriolis term, and the one that dissipates energy relative to the other one is used. This is only available at present if Coriolis scheme is SADOURNY75_ENERGY.
% weno_velocity_smooth :: logical If true, use velocity to compute the smoothness indicator for WENO.
% time :: type(time_type), pointer A pointer to the ocean model’s clock.
% diag :: type(diag_ctrl), pointer A structure that is used to regulate the timing of diagnostic output.

mom_coriolisadv module reference

Data Types

Functions/Subroutines

Detailed Description

Type Documentation

Function/Subroutine Documentation