namespace mom_dyn_horgrid

Overview

Contains a shareable dynamic type for describing horizontal grids and metric data and utilty routines that work on this type. More…

namespace mom_dyn_horgrid {

// global functions

subroutine, public create_dyn_horgrid(G G, HI HI, bathymetry_at_vel bathymetry_at_vel);
subroutine, public rescale_dyn_horgrid_bathymetry(G G, m_in_new_units m_in_new_units);
subroutine, public set_derived_dyn_horgrid(G G, US US);
subroutine, public destroy_dyn_horgrid(G G);

} // namespace mom_dyn_horgrid

Detailed Documentation

Contains a shareable dynamic type for describing horizontal grids and metric data and utilty routines that work on this type.

Global Functions

subroutine, public create_dyn_horgrid(
    G G,
    HI HI,
    bathymetry_at_vel bathymetry_at_vel
    )

Allocate memory used by the dyn_horgrid_type and related structures.

Parameters:

g	A pointer to the dynamic horizontal grid type
hi	A hor_index_type for array extents
bathymetry_at_vel	If true, there are separate values for the basin depths at velocity points. Otherwise the effects of topography are entirely determined from thickness points.

subroutine, public rescale_dyn_horgrid_bathymetry(
    G G,
    m_in_new_units m_in_new_units
    )

rescale_dyn_horgrid_bathymetry permits a change in the internal units for the bathymetry on the grid, both rescaling the depths and recording the new internal depth units.

Parameters:

g	The dynamic horizontal grid type
m_in_new_units	The new internal representation of 1 m depth.

subroutine, public set_derived_dyn_horgrid(G G, US US)

set_derived_dyn_horgrid calculates metric terms that are derived from other metrics.

Parameters:

g	The dynamic horizontal grid type
us	A dimensional unit scaling type

subroutine, public destroy_dyn_horgrid(G G)

Release memory used by the dyn_horgrid_type and related structures.

Parameters:

g	The dynamic horizontal grid type