Detailed Description

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.

Data Types
type	pressureforce_cs

Functions/Subroutines
subroutine, public	pressureforce (h, tv, PFu, PFv, G, GV, CS, ALE_CSp, p_atm, pbce, eta)
	A thin layer between the model and the Boussinesq and non-Boussinesq pressure force routines. More...

subroutine, public	pressureforce_init (Time, G, GV, param_file, diag, CS, tides_CSp)
	Initialize the pressure force control structure. More...

subroutine, public	pressureforce_end (CS)
	Deallocate the pressure force control structure. More...

Function/Subroutine Documentation

◆ pressureforce()

subroutine, public mom_pressureforce::pressureforce	(	real, dimension( g %isd: g %ied, g %jsd: g %jed, g %ke), intent(in)	h,
		type(thermo_var_ptrs), intent(in)	tv,
		real, dimension( g %isdb: g %iedb, g %jsd: g %jed, g %ke), intent(out)	PFu,
		real, dimension( g %isd: g %ied, g %jsdb: g %jedb, g %ke), intent(out)	PFv,
		type(ocean_grid_type), intent(in)	G,
		type(verticalgrid_type), intent(in)	GV,
		type(pressureforce_cs), pointer	CS,
		type(ale_cs), pointer	ALE_CSp,
		real, dimension(:,:), optional, pointer	p_atm,
		real, dimension( g %isd: g %ied, g %jsd: g %jed, g %ke), intent(out), optional	pbce,
		real, dimension( g %isd: g %ied, g %jsd: g %jed), intent(out), optional	eta
	)

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

Parameters

[in]	g	The ocean's grid structure
[in]	gv	The ocean's vertical grid structure
[in]	h	Layer thicknesses, in H (usually m or kg m-2)
[in]	tv	A structure pointing to various thermodynamic variables

Definition at line 38 of file MOM_PressureForce.F90.

Referenced by mom_dynamics_legacy_split::step_mom_dyn_legacy_split(), mom_dynamics_split_rk2::step_mom_dyn_split_rk2(), mom_dynamics_unsplit::step_mom_dyn_unsplit(), and mom_dynamics_unsplit_rk2::step_mom_dyn_unsplit_rk2().

   type(ocean_grid_type),                     intent(in)  :: g    !< The ocean's grid structure
   type(verticalgrid_type),                   intent(in)  :: gv   !< The ocean's vertical grid structure
   real, dimension(SZI_(G),SZJ_(G),SZK_(G)),  intent(in)  :: h    !< Layer thicknesses, in H (usually m or kg m-2)
   type(thermo_var_ptrs),                     intent(in)  :: tv   !< A structure pointing to various thermodynamic variables
   real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), intent(out) :: pfu
   real, dimension(SZI_(G),SZJB_(G),SZK_(G)), intent(out) :: pfv
   type(pressureforce_cs),                    pointer     :: cs
   type(ale_cs),                              pointer     :: ale_csp
   real, dimension(:,:),                     optional, pointer     :: p_atm
   real, dimension(SZI_(G),SZJ_(G),SZK_(G)), optional, intent(out) :: pbce
   real, dimension(SZI_(G),SZJ_(G)),         optional, intent(out) :: eta
 
 
   if (cs%Analytic_FV_PGF) then
     if (gv%Boussinesq) then
       call pressureforce_afv_bouss(h, tv, pfu, pfv, g, gv, cs%PressureForce_AFV_CSp, &
                                    ale_csp, p_atm, pbce, eta)
     else
       call pressureforce_afv_nonbouss(h, tv, pfu, pfv, g, gv, cs%PressureForce_AFV_CSp, &
                                       p_atm, pbce, eta)
     endif
   else
     if (gv%Boussinesq) then
       call pressureforce_mont_bouss(h, tv, pfu, pfv, g, gv, cs%PressureForce_Mont_CSp, &
                                     p_atm, pbce, eta)
     else
       call pressureforce_mont_nonbouss(h, tv, pfu, pfv, g, gv, cs%PressureForce_Mont_CSp, &
                                        p_atm, pbce, eta)
     endif
   endif
 

Here is the caller graph for this function:

◆ pressureforce_end()

subroutine, public mom_pressureforce::pressureforce_end ( type(pressureforce_cs), pointer CS )

Deallocate the pressure force control structure.

Parameters

cs	Pressure force control structure

Definition at line 110 of file MOM_PressureForce.F90.

110 type(pressureforce_cs), pointer :: cs !< Pressure force control structure

111 if (associated(cs)) deallocate(cs)

◆ pressureforce_init()

subroutine, public mom_pressureforce::pressureforce_init	(	type(time_type), intent(in), target	Time,
		type(ocean_grid_type), intent(in)	G,
		type(verticalgrid_type), intent(in)	GV,
		type(param_file_type), intent(in)	param_file,
		type(diag_ctrl), intent(inout), target	diag,
		type(pressureforce_cs), pointer	CS,
		type(tidal_forcing_cs), optional, pointer	tides_CSp
	)

Initialize the pressure force control structure.

Parameters

[in]	time	Current model time
[in]	g	Ocean grid structure
[in]	gv	Vertical grid structure
[in]	param_file	Parameter file handles
[in,out]	diag	Diagnostics control structure
	cs	Pressure force control structure
	tides_csp	Tide control structure

Definition at line 73 of file MOM_PressureForce.F90.

References mom_error_handler::mom_error(), mom_pressureforce_afv::pressureforce_afv_init(), and mom_pressureforce_mont::pressureforce_mont_init().

   type(time_type), target, intent(in)    :: time !< Current model time
   type(ocean_grid_type),   intent(in)    :: g    !< Ocean grid structure
   type(verticalgrid_type), intent(in)    :: gv   !< Vertical grid structure
   type(param_file_type),   intent(in)    :: param_file !< Parameter file handles
   type(diag_ctrl), target, intent(inout) :: diag !< Diagnostics control structure
   type(pressureforce_cs),  pointer       :: cs   !< Pressure force control structure
   type(tidal_forcing_cs), optional, pointer :: tides_csp !< Tide control structure
 #include "version_variable.h"
   character(len=40)  :: mdl = "MOM_PressureForce" ! This module's name.
 
   if (associated(cs)) then
     call mom_error(warning, "PressureForce_init called with an associated "// &
                             "control structure.")
     return
   else ; allocate(cs) ; endif
 
   ! Read all relevant parameters and write them to the model log.
   call log_version(param_file, mdl, version, "")
   call get_param(param_file, mdl, "ANALYTIC_FV_PGF", cs%Analytic_FV_PGF, &
                  "If true the pressure gradient forces are calculated \n"//&
                  "with a finite volume form that analytically integrates \n"//&
                  "the equations of state in pressure to avoid any \n"//&
                  "possibility of numerical thermobaric instability, as \n"//&
                  "described in Adcroft et al., O. Mod. (2008).", default=.true.)
 
   if (cs%Analytic_FV_PGF) then
     call pressureforce_afv_init(time, g, gv, param_file, diag, &
              cs%PressureForce_AFV_CSp, tides_csp)
   else
     call pressureforce_mont_init(time, g, gv, param_file, diag, &
              cs%PressureForce_Mont_CSp, tides_csp)
   endif
 

Here is the call graph for this function:

Detailed Description

Data Types

Functions/Subroutines

Function/Subroutine Documentation

◆ pressureforce()

◆ pressureforce_end()

◆ pressureforce_init()