coord_sigma module reference

Regrid columns for the sigma coordinate.

More…

Data Types

sigma_cs

Control structure containing required parameters for the sigma coordinate.

Functions/Subroutines

init_coord_sigma()

Initialise a sigma_CS with pointers to parameters.

end_coord_sigma()

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

set_sigma_params()

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

build_sigma_column()

Build a sigma coordinate column.

Detailed Description

Regrid columns for the sigma coordinate.

Type Documentation

type coord_sigma/sigma_cs

Control structure containing required parameters for the sigma coordinate.

Type fields:

  • % nk [integer] :: Number of levels.

  • % min_thickness [real] :: Minimum thickness allowed for layers [H ~> m or kg m-2].

  • % coordinateresolution [real(:),allocatable] :: Target coordinate resolution [nondim].

Function/Subroutine Documentation

subroutine coord_sigma/init_coord_sigma(CS, nk, coordinateResolution)

Initialise a sigma_CS with pointers to parameters.

Parameters:

  • cs :: Unassociated pointer to hold the control structure

  • nk :: [in] Number of layers in the grid

  • coordinateresolution :: [in] Nominal coordinate resolution [nondim]

Call to:

mom_error_handler::mom_error

Called from:

mom_regridding::initcoord

subroutine coord_sigma/end_coord_sigma(CS)

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

Parameters:

cs :: Coordinate control structure

Called from:

mom_regridding::end_regridding

subroutine coord_sigma/set_sigma_params(CS, min_thickness)

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

Parameters:

  • cs :: Coordinate control structure

  • min_thickness :: [in] Minimum allowed thickness [H ~> m or kg m-2]

Call to:

mom_error_handler::mom_error

Called from:

mom_regridding::set_regrid_params

subroutine coord_sigma/build_sigma_column(CS, depth, totalThickness, zInterface)

Build a sigma coordinate column.

Parameters:

  • cs :: [in] Coordinate control structure

  • depth :: [in] Depth of ocean bottom (positive [H ~> m or kg m-2])

  • totalthickness :: [in] Column thickness (positive [H ~> m or kg m-2])

  • zinterface :: [inout] Absolute positions of interfaces [H ~> m or kg m-2]

Called from:

mom_regridding::build_sigma_grid mom_diag_remap::diag_remap_update