namespace coord_zlike

Overview

Regrid columns for a z-like coordinate (z-star, z-level) More…

namespace coord_zlike {

// global functions

subroutine, public init_coord_zlike(CS CS, nk nk, coordinateResolution coordinateResolution);
subroutine, public end_coord_zlike(CS CS);
subroutine, public set_zlike_params(CS CS, min_thickness min_thickness);

subroutine, public build_zstar_column(
    CS CS,
    depth depth,
    total_thickness total_thickness,
    zInterface zInterface,
    z_rigid_top z_rigid_top,
    eta_orig eta_orig,
    zScale zScale
    );

} // namespace coord_zlike

Detailed Documentation

Regrid columns for a z-like coordinate (z-star, z-level)

Global Functions

subroutine, public init_coord_zlike(
    CS CS,
    nk nk,
    coordinateResolution coordinateResolution
    )

Initialise a zlike_CS with pointers to parameters.

Parameters:

cs	Unassociated pointer to hold the control structure
nk	Number of levels in the grid
coordinateresolution	Target coordinate resolution [Z ~> m]

subroutine, public end_coord_zlike(CS CS)

Deallocates the zlike control structure.

Parameters:

cs	Coordinate control structure

subroutine, public set_zlike_params(CS CS, min_thickness min_thickness)

Set parameters in the zlike structure.

Parameters:

cs	Coordinate control structure
min_thickness	Minimum allowed thickness [H ~> m or kg m-2]

subroutine, public build_zstar_column(
    CS CS,
    depth depth,
    total_thickness total_thickness,
    zInterface zInterface,
    z_rigid_top z_rigid_top,
    eta_orig eta_orig,
    zScale zScale
    )

Builds a z* coordinate with a minimum thickness.

Parameters:

cs	Coordinate control structure
depth	Depth of ocean bottom (positive in the output units)
total_thickness	Column thickness (positive in the same units as depth)
zinterface	Absolute positions of interfaces
z_rigid_top	The height of a rigid top (negative in the same units as depth)
eta_orig	The actual original height of the top in the same units as depth
zscale	Scaling factor from the target coordinate resolution in Z to desired units for zInterface, perhaps Z_to_H