namespace isomip_initialization

Overview

Configures the ISOMIP test case. More…

namespace isomip_initialization {

// global functions

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

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

subroutine, public isomip_initialize_temperature_salinity(
    T T,
    S S,
    h h,
    G G,
    GV GV,
    param_file param_file,
    eqn_of_state eqn_of_state,
    just_read_params just_read_params
    );

subroutine, public isomip_initialize_sponges(
    G G,
    GV GV,
    US US,
    tv tv,
    PF PF,
    use_ALE use_ALE,
    CSp CSp,
    ACSp ACSp
    );

} // namespace isomip_initialization

Detailed Documentation

Configures the ISOMIP test case.

See this paper for details: http://www.geosci-model-dev-discuss.net/8/9859/2015/gmdd-8-9859-2015.pdf

Global Functions

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

Initialization of topography for the ISOMIP configuration.

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

subroutine, public isomip_initialize_thickness(
    h h,
    G G,
    GV GV,
    US US,
    param_file param_file,
    tv tv,
    just_read_params just_read_params
    )

Initialization of thicknesses.

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.
tv	A structure containing pointers to any available thermodynamic fields, including the eqn. of state.
just_read_params	If present and true, this call will only read parameters without changing h.

subroutine, public isomip_initialize_temperature_salinity(
    T T,
    S S,
    h h,
    G G,
    GV GV,
    param_file param_file,
    eqn_of_state eqn_of_state,
    just_read_params just_read_params
    )

Initial values for temperature and salinity.

Parameters:

g	Ocean grid structure
gv	Vertical grid structure
t	Potential temperature [degC]
s	Salinity [ppt]
h	Layer thickness [H ~> m or kg m-2]
param_file	Parameter file structure
eqn_of_state	Equation of state structure
just_read_params	If present and true, this call will only read parameters without changing T & S.

subroutine, public isomip_initialize_sponges(
    G G,
    GV GV,
    US US,
    tv tv,
    PF PF,
    use_ALE use_ALE,
    CSp CSp,
    ACSp ACSp
    )

Sets up the the inverse restoration time (Idamp), and.

Parameters:

g	The ocean’s grid structure.
gv	The ocean’s 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.
pf	A structure indicating the open file to parse for model parameter values.
use_ale	If true, indicates model is in ALE mode
csp	Layer-mode sponge structure
acsp	ALE-mode sponge structure