namespace neverland_initialization¶
Overview¶
Initialization for the “Neverland” configuration. More…
namespace neverland_initialization { // global functions subroutine, public neverland_initialize_topography(D D, G G, param_file param_file, max_depth max_depth); subroutine, public neverland_initialize_thickness( h h, G G, GV GV, US US, param_file param_file, eqn_of_state eqn_of_state, P_ref P_ref ); } // namespace neverland_initialization
Detailed Documentation¶
Initialization for the “Neverland” configuration.
Global Functions¶
subroutine, public neverland_initialize_topography( D D, G G, param_file param_file, max_depth max_depth )
This subroutine sets up the Neverland test case topography.
Parameters:
g |
The dynamic horizontal grid type |
d |
Ocean bottom depth in the units of depth_max |
param_file |
Parameter file structure |
max_depth |
Maximum ocean depth in arbitrary units |
subroutine, public neverland_initialize_thickness( h h, G G, GV GV, US US, param_file param_file, eqn_of_state eqn_of_state, P_ref P_ref )
This subroutine initializes layer thicknesses for the Neverland test case, by finding the depths of interfaces in a specified latitude-dependent temperature profile with an exponentially decaying thermocline on top of a linear stratification.
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. |
eqn_of_state |
integer that selects the equation of state. |
p_ref |
The coordinate-density reference pressure [Pa]. |