namespace phillips_initialization

Overview

Initialization for the “Phillips” channel configuration. More…

namespace phillips_initialization {

// global functions

subroutine, public phillips_initialize_thickness(
    h h,
    G G,
    GV GV,
    US US,
    param_file param_file,
    just_read_params just_read_params
    );

subroutine, public phillips_initialize_velocity(
    u u,
    v v,
    G G,
    GV GV,
    US US,
    param_file param_file,
    just_read_params just_read_params
    );

subroutine, public phillips_initialize_sponges(
    G G,
    GV GV,
    US US,
    tv tv,
    param_file param_file,
    CSp CSp,
    h h
    );

subroutine, public phillips_initialize_topography(D D, G G, param_file param_file, max_depth max_depth, US US);

} // namespace phillips_initialization

Detailed Documentation

Initialization for the “Phillips” channel configuration.

By Robert Hallberg, April 1994 - June 2002

This subroutine initializes the fields for the simulations. The one argument passed to initialize, Time, is set to the current time of the simulation. The fields which are initialized here are: u - Zonal velocity [m s-1]. v - Meridional velocity [m s-1]. h - Layer thickness in m. (Must be positive.) D - Basin depth in m. (Must be positive.) f - The Coriolis parameter [s-1]. g - The reduced gravity at each interface [m s-2] Rlay - Layer potential density (coordinate variable) [kg m-3]. If ENABLE_THERMODYNAMICS is defined: T - Temperature [degC]. S - Salinity [ppt]. If SPONGE is defined: A series of subroutine calls are made to set up the damping rates and reference profiles for all variables that are damped in the sponge. Any user provided tracer code is also first linked through this subroutine.

Forcing-related fields (taux, tauy, buoy, ustar, etc.) are set in MOM_surface_forcing.F90.

These variables are all set in the set of subroutines (in this file) Phillips_initialize_thickness, Phillips_initialize_velocity, Phillips_initialize_topography and Phillips_initialize_sponges that seet up fields that are specific to the Phillips instability test case.

Global Functions

subroutine, public phillips_initialize_thickness(
    h h,
    G G,
    GV GV,
    US US,
    param_file param_file,
    just_read_params just_read_params
    )

Initialize the thickness field for the Phillips model test case.

Parameters:

g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
us	A dimensional unit scaling type
h	The thickness that is being initialized [H ~> m or kg m-2]
param_file	A structure indicating the open file to parse for model parameter values.
just_read_params	If present and true, this call will only read parameters without changing h.

subroutine, public phillips_initialize_velocity(
    u u,
    v v,
    G G,
    GV GV,
    US US,
    param_file param_file,
    just_read_params just_read_params
    )

Initialize the velocity fields for the Phillips model test case.

Parameters:

g	Grid structure
gv	Vertical grid structure
u	i-component of velocity [L T-1 ~> m s-1]
v	j-component of velocity [L T-1 ~> m s-1]
us	A dimensional unit scaling type
param_file	A structure indicating the open file to parse for modelparameter values.
just_read_params	If present and true, this call will only read parameters without changing h.

subroutine, public phillips_initialize_sponges(
    G G,
    GV GV,
    US US,
    tv tv,
    param_file param_file,
    CSp CSp,
    h h
    )

Sets up the the inverse restoration time (Idamp), and the values towards which the interface heights and an arbitrary number of tracers should be restored within each sponge for the Phillips model test case.

Parameters:

g	The ocean’s grid structure.
gv	Vertical grid structure
us	A dimensional unit scaling type
tv	A structure containing pointers to any available thermodynamic fields, potential temperature and salinity or mixed layer density. Absent fields have NULL ptrs.
param_file	A structure indicating the open file to parse for model parameter values.
csp	A pointer that is set to point to the control structure for the sponge module.
h	Thickness field [H ~> m or kg m-2].

subroutine, public phillips_initialize_topography(
    D D,
    G G,
    param_file param_file,
    max_depth max_depth,
    US US
    )

Initialize topography.

Parameters:

g	The dynamic horizontal grid type
d	Ocean bottom depth in m or Z if US is present
param_file	Parameter file structure
max_depth	Maximum model depth in the units of D
us	A dimensional unit scaling type