namespace coord_sigma

Overview

Regrid columns for the sigma coordinate. More…

namespace coord_sigma {

// global functions

subroutine, public init_coord_sigma(CS CS, nk nk, coordinateResolution coordinateResolution);
subroutine, public end_coord_sigma(CS CS);
subroutine, public set_sigma_params(CS CS, min_thickness min_thickness);

subroutine, public build_sigma_column(
    CS CS,
    depth depth,
    totalThickness totalThickness,
    zInterface zInterface
    );

} // namespace coord_sigma

Detailed Documentation

Regrid columns for the sigma coordinate.

Global Functions

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

Initialise a sigma_CS with pointers to parameters.

Parameters:

cs	Unassociated pointer to hold the control structure
nk	Number of layers in the grid
coordinateresolution	Nominal coordinate resolution [nondim]

subroutine, public end_coord_sigma(CS CS)

This subroutine deallocates memory in the control structure for the coord_sigma module.

Parameters:

cs	Coordinate control structure

subroutine, public set_sigma_params(CS CS, min_thickness min_thickness)

This subroutine can be used to set the parameters for the coord_sigma module.

Parameters:

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

subroutine, public build_sigma_column(
    CS CS,
    depth depth,
    totalThickness totalThickness,
    zInterface zInterface
    )

Build a sigma coordinate column.

Parameters:

cs	Coordinate control structure
depth	Depth of ocean bottom (positive [H ~> m or kg m-2])
totalthickness	Column thickness (positive [H ~> m or kg m-2])
zinterface	Absolute positions of interfaces [H ~> m or kg m-2]