coord_zlike module reference¶
Regrid columns for a z-like coordinate (z-star, z-level)
Data Types¶
Control structure containing required parameters for a z-like coordinate. |
Functions/Subroutines¶
Initialise a zlike_CS with pointers to parameters. |
|
Deallocates the zlike control structure. |
|
Set parameters in the zlike structure. |
|
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:
- Called from:
-
subroutine
coord_zlike/
end_coord_zlike
(CS)¶ Deallocates the zlike control structure.
- Parameters:
cs :: Coordinate control structure
- Called from:
-
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:
- Called from:
-
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
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
- Called from:
mom_regridding::build_zstar_grid
mom_diag_remap::diag_remap_update