namespace mom_pressureforce

Overview

A thin wrapper for Boussinesq/non-Boussinesq forms of the pressure force calculation. More…

namespace mom_pressureforce {

// global functions

subroutine, public pressureforce(
    h h,
    tv tv,
    PFu PFu,
    PFv PFv,
    G G,
    GV GV,
    US US,
    CS CS,
    ALE_CSp ALE_CSp,
    p_atm p_atm,
    pbce pbce,
    eta eta
    );

subroutine, public pressureforce_init(
    Time Time,
    G G,
    GV GV,
    US US,
    param_file param_file,
    diag diag,
    CS CS,
    tides_CSp tides_CSp
    );

subroutine, public pressureforce_end(CS CS);

} // namespace mom_pressureforce

Detailed Documentation

A thin wrapper for Boussinesq/non-Boussinesq forms of the pressure force calculation.

This thin module provides a branch to two forms of the horizontal accelerations due to pressure gradients. The two options currently available are a Montgomery potential form (used in traditional isopycnal layer models), and the analytic finite volume form.

Global Functions

subroutine, public pressureforce(
    h h,
    tv tv,
    PFu PFu,
    PFv PFv,
    G G,
    GV GV,
    US US,
    CS CS,
    ALE_CSp ALE_CSp,
    p_atm p_atm,
    pbce pbce,
    eta eta
    )

A thin layer between the model and the Boussinesq and non-Boussinesq pressure force routines.

Parameters:

g	The ocean’s grid structure
gv	The ocean’s vertical grid structure
us	A dimensional unit scaling type
h	Layer thicknesses [H ~> m or kg m-2]
tv	A structure pointing to various thermodynamic variables
pfu	Zonal pressure force acceleration [L T-2 ~> m s-2]
pfv	Meridional pressure force acceleration [L T-2 ~> m s-2]
cs	Pressure force control structure
ale_csp	ALE control structure
p_atm	The pressure at the ice-ocean or
pbce	The baroclinic pressure anomaly in each layer
eta	The bottom mass used to calculate PFu and PFv,

subroutine, public pressureforce_init(
    Time Time,
    G G,
    GV GV,
    US US,
    param_file param_file,
    diag diag,
    CS CS,
    tides_CSp tides_CSp
    )

Initialize the pressure force control structure.

Parameters:

time	Current model time
g	Ocean grid structure
gv	Vertical grid structure
us	A dimensional unit scaling type
param_file	Parameter file handles
diag	Diagnostics control structure
cs	Pressure force control structure
tides_csp	Tide control structure

subroutine, public pressureforce_end(CS CS)

Deallocate the pressure force control structure.

Parameters:

cs	Pressure force control structure