coord_zlike module reference

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

More…

Data Types

zlike_cs

Control structure containing required parameters for a z-like coordinate.

Functions/Subroutines

init_coord_zlike()

Initialise a zlike_CS with pointers to parameters.

end_coord_zlike()

Deallocates the zlike control structure.

set_zlike_params()

Set parameters in the zlike structure.

build_zstar_column()

Builds a z* coordinate with a minimum thickness.

Detailed Description

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

Type Documentation

type coord_zlike/zlike_cs

Control structure containing required parameters for a z-like coordinate.

Type fields:

  • % nk [integer] :: Number of levels to be generated.

  • % min_thickness [real] :: Minimum thickness allowed for layers, in the same thickness units (perhaps [H ~> m or kg m-2]) that will be used in all subsequent calls to build_zstar_column with this structure.

  • % coordinateresolution [real(:),allocatable] :: Target coordinate resolution, usually in [Z ~> m].

Function/Subroutine Documentation

subroutine coord_zlike/init_coord_zlike(CS, nk, coordinateResolution)

Initialise a zlike_CS with pointers to parameters.

Parameters:

  • cs :: Unassociated pointer to hold the control structure

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

  • coordinateresolution :: [in] Target coordinate resolution [Z ~> m]

Call to:

mom_error_handler::mom_error

Called from:

mom_regridding::initcoord

subroutine coord_zlike/end_coord_zlike(CS)

Deallocates the zlike control structure.

Parameters:

cs :: Coordinate control structure

Called from:

mom_regridding::end_regridding

subroutine coord_zlike/set_zlike_params(CS, min_thickness)

Set parameters in the zlike structure.

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_zlike/build_zstar_column(CS, depth, total_thickness, zInterface, z_rigid_top, eta_orig, zScale)

Builds a z* coordinate with a minimum thickness.

Parameters:

  • cs :: [in] Coordinate control structure

  • depth :: [in] Depth of ocean bottom (positive downward in the output units), units may be [Z ~> m] or [H ~> m or kg m-2]

  • total_thickness :: [in] Column thickness (positive definite in the same units as depth) [Z ~> m] or [H ~> m or kg m-2]

  • zinterface :: [inout] Absolute positions of interfaces (in the same units as depth) [Z ~> m] or [H ~> m or kg m-2]

  • z_rigid_top :: [in] The height of a rigid top (positive upward in the same units as depth) [Z ~> m] or [H ~> m or kg m-2]

  • eta_orig :: [in] The actual original height of the top (in the same units as depth) [Z ~> m] or [H ~> m or kg m-2]

  • zscale :: [in] Scaling factor from the target coordinate resolution in Z to desired units for zInterface, perhaps Z_to_H, often [nondim] or [H Z-1 ~> 1 or kg m-3]

Called from:

mom_regridding::build_zstar_grid mom_diag_remap::diag_remap_update