namespace adjustment_initialization

Overview

Configures the model for the geostrophic adjustment test case. More…

namespace adjustment_initialization {

// global functions

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

subroutine, public adjustment_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
    );

} // namespace adjustment_initialization

Detailed Documentation

Configures the model for the geostrophic adjustment test case.

Global Functions

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

Initializes the layer thicknesses in the adjustment 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 adjustment_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
    )

Initialization of temperature and salinity in the adjustment test case.

Parameters:

g

The ocean’s grid structure.

gv

The ocean’s vertical grid structure.

t

The temperature that is being initialized.

s

The salinity that is being initialized.

h

The model thicknesses [H ~> m or kg m-2].

param_file

A structure indicating the open file to parse for model parameter values.

eqn_of_state

Equation of state.

just_read_params

If present and true, this call will only read parameters without changing T & S.