MOM6
|
Regrid columns for the HyCOM coordinate.
Data Types | |
type | hycom_cs |
Control structure containing required parameters for the HyCOM coordinate. More... | |
Functions/Subroutines | |
subroutine, public | init_coord_hycom (CS, nk, coordinateResolution, target_density, interp_CS, rho_scale) |
Initialise a hycom_CS with pointers to parameters. More... | |
subroutine, public | end_coord_hycom (CS) |
This subroutine deallocates memory in the control structure for the coord_hycom module. More... | |
subroutine, public | set_hycom_params (CS, max_interface_depths, max_layer_thickness, interp_CS) |
This subroutine can be used to set the parameters for the coord_hycom module. More... | |
subroutine, public | build_hycom1_column (CS, eqn_of_state, nz, depth, h, T, S, p_col, z_col, z_col_new, zScale, h_neglect, h_neglect_edge) |
Build a HyCOM coordinate column. More... | |
subroutine, public coord_hycom::build_hycom1_column | ( | type(hycom_cs), intent(in) | CS, |
type(eos_type), pointer | eqn_of_state, | ||
integer, intent(in) | nz, | ||
real, intent(in) | depth, | ||
real, dimension(nz), intent(in) | h, | ||
real, dimension(nz), intent(in) | T, | ||
real, dimension(nz), intent(in) | S, | ||
real, dimension(nz), intent(in) | p_col, | ||
real, dimension(nz+1), intent(in) | z_col, | ||
real, dimension(cs%nk+1), intent(inout) | z_col_new, | ||
real, intent(in), optional | zScale, | ||
real, intent(in), optional | h_neglect, | ||
real, intent(in), optional | h_neglect_edge | ||
) |
Build a HyCOM coordinate column.
[in] | cs | Coordinate control structure |
eqn_of_state | Equation of state structure | |
[in] | nz | Number of levels |
[in] | depth | Depth of ocean bottom (positive [H ~> m or kg m-2]) |
[in] | t | Temperature of column [degC] |
[in] | s | Salinity of column [ppt] |
[in] | h | Layer thicknesses, in [m] or [H ~> m or kg m-2] |
[in] | p_col | Layer pressure [Pa] |
[in] | z_col | Interface positions relative to the surface [H ~> m or kg m-2] |
[in,out] | z_col_new | Absolute positions of interfaces |
[in] | zscale | Scaling factor from the input thicknesses in [m] to desired units for zInterface, perhaps m_to_H. |
[in] | h_neglect | A negligibly small width for the purpose of cell reconstructions in the same units as h. |
[in] | h_neglect_edge | A negligibly small width for the purpose of edge value calculations in the same units as h0. |
Definition at line 105 of file coord_hycom.F90.
References regrid_interp::build_and_interpolate_grid().
Referenced by mom_regridding::build_grid_hycom1().
subroutine, public coord_hycom::end_coord_hycom | ( | type(hycom_cs), pointer | CS | ) |
This subroutine deallocates memory in the control structure for the coord_hycom module.
cs | Coordinate control structure |
Definition at line 65 of file coord_hycom.F90.
Referenced by mom_regridding::end_regridding().
subroutine, public coord_hycom::init_coord_hycom | ( | type(hycom_cs), pointer | CS, |
integer, intent(in) | nk, | ||
real, dimension(nk), intent(in) | coordinateResolution, | ||
real, dimension(nk+1), intent(in) | target_density, | ||
type(interp_cs_type), intent(in) | interp_CS, | ||
real, intent(in), optional | rho_scale | ||
) |
Initialise a hycom_CS with pointers to parameters.
cs | Unassociated pointer to hold the control structure | |
[in] | nk | Number of layers in generated grid |
[in] | coordinateresolution | Nominal near-surface resolution [m] |
[in] | target_density | Interface target densities [R ~> kg m-3] |
[in] | interp_cs | Controls for interpolation |
[in] | rho_scale | A dimensional scaling factor for target_density |
Definition at line 43 of file coord_hycom.F90.
References mom_error_handler::mom_error().
Referenced by mom_regridding::initcoord().
subroutine, public coord_hycom::set_hycom_params | ( | type(hycom_cs), pointer | CS, |
real, dimension(:), intent(in), optional | max_interface_depths, | ||
real, dimension(:), intent(in), optional | max_layer_thickness, | ||
type(interp_cs_type), intent(in), optional | interp_CS | ||
) |
This subroutine can be used to set the parameters for the coord_hycom module.
cs | Coordinate control structure | |
[in] | max_interface_depths | Maximum depths of interfaces in m |
[in] | max_layer_thickness | Maximum thicknesses of layers in m |
[in] | interp_cs | Controls for interpolation |
Definition at line 78 of file coord_hycom.F90.
References mom_error_handler::mom_error().
Referenced by mom_regridding::set_regrid_max_depths(), mom_regridding::set_regrid_max_thickness(), and mom_regridding::set_regrid_params().