mom_shared_initialization module reference

Code that initializes fixed aspects of the model grid, such as horizontal grid metrics, topography and Coriolis, and can be shared between components.

More…

Functions/Subroutines

`mom_shared_init_init()`	MOM_shared_init_init just writes the code version.
`mom_initialize_rotation()`	MOM_initialize_rotation makes the appropriate call to set up the Coriolis parameter.
`mom_calculate_grad_coriolis()`	Calculates the components of grad f (Coriolis parameter)
`diagnosemaximumdepth()`	Return the global maximum ocean bottom depth in the same units as the input depth.
`set_meansl_from_file()`	Read time mean ocean sea level from a file.
`initialize_topography_from_file()`	Read gridded depths from file.
`apply_topography_edits_from_file()`	Applies a list of topography overrides read from a netcdf file.
`initialize_topography_named()`	initialize the bathymetry based on one of several named idealized configurations
`limit_topography()`	limit_topography ensures that min_depth < D(x,y) < max_depth
`set_rotation_planetary()`	This subroutine sets up the Coriolis parameter for a sphere.
`set_rotation_beta_plane()`	This subroutine sets up the Coriolis parameter for a beta-plane or f-plane.
`initialize_grid_rotation_angle()`	initialize_grid_rotation_angle initializes the arrays with the sine and cosine of the angle between logical north on the grid and true north.
`modulo_around_point()`	Return the modulo value of x in an interval [xc-(Lx/2) xc+(Lx/2)] If Lx<=0, then it returns x without applying modulo arithmetic.
`reset_face_lengths_named()`	This subroutine sets the open face lengths at selected points to restrict passages to their observed widths based on a named set of sizes.
`reset_face_lengths_file()`	This subroutine sets the open face lengths at selected points to restrict passages to their observed widths from a arrays read from a file.
`reset_face_lengths_list()`	This subroutine sets the open face lengths at selected points to restrict passages to their observed widths from a list read from a file.
`read_face_length_list()`	This subroutine reads and counts the non-blank lines in the face length list file, after removing comments.
`set_subgrid_topo_at_vel_from_file()`	Read from a file the maximum, minimum and average bathymetry at velocity points, for the use of porous barrier.
`set_velocity_depth_max()`	Set the bathymetry at velocity points to be the maximum of the depths at the neighoring tracer points.
`set_velocity_depth_min()`	Set the bathymetry at velocity points to be the minimum of the depths at the neighoring tracer points.
`compute_global_grid_integrals()`	Pre-compute global integrals of grid quantities (like masked ocean area) for later use in reporting diagnostics.
`write_ocean_geometry_file()`	Write out a file describing the topography, Coriolis parameter, grid locations and various other fixed fields from the grid.

Detailed Description

Code that initializes fixed aspects of the model grid, such as horizontal grid metrics, topography and Coriolis, and can be shared between components.

Function/Subroutine Documentation

subroutine mom_shared_initialization/mom_shared_init_init(PF)

MOM_shared_init_init just writes the code version.

Parameters:: pf :: [in] A structure indicating the open file to parse for model parameter values.