coord_hycom coord_hycom::hycom_cs subroutine, public subroutine, public coord_hycom::init_coord_hycom (CS, nk, coordinateResolution, target_density, interp_CS) init_coord_hycom CS CS nk nk coordinateResolution coordinateResolution target_density target_density interp_CS interp_CS Initialise a hycom_CS with pointers to parameters. cs Unassociated pointer to hold the control structure nk Number of layers in generated grid coordinateresolution Nominal near-surface resolution [Z ~> m] target_density Interface target densities [R ~> kg m-3] interp_cs Controls for interpolation mom_error_handler::mom_error mom_regridding::initcoord subroutine, public subroutine, public coord_hycom::end_coord_hycom (CS) end_coord_hycom CS CS This subroutine deallocates memory in the control structure for the coord_hycom module. cs Coordinate control structure mom_regridding::end_regridding subroutine, public subroutine, public coord_hycom::set_hycom_params (CS, max_interface_depths, max_layer_thickness, interp_CS) set_hycom_params CS CS max_interface_depths max_interface_depths max_layer_thickness max_layer_thickness interp_CS interp_CS This subroutine can be used to set the parameters for the coord_hycom module. cs Coordinate control structure max_interface_depths Maximum depths of interfaces [H ~> m or kg m-2] max_layer_thickness Maximum thicknesses of layers [H ~> m or kg m-2] interp_cs Controls for interpolation mom_error_handler::mom_error mom_regridding::set_regrid_max_depths mom_regridding::set_regrid_max_thickness mom_regridding::set_regrid_params subroutine, public subroutine, public coord_hycom::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_hycom1_column CS CS eqn_of_state eqn_of_state nz nz depth depth h h T T S S p_col p_col z_col z_col z_col_new z_col_new zScale zScale h_neglect h_neglect h_neglect_edge h_neglect_edge Build a HyCOM coordinate column. cs Coordinate control structure eqn_of_state Equation of state structure nz Number of levels depth Depth of ocean bottom (positive [H ~> m or kg m-2]) t Temperature of column [degC] s Salinity of column [ppt] h Layer thicknesses [H ~> m or kg m-2] p_col Layer pressure [R L2 T-2 ~> Pa] z_col Interface positions relative to the surface [H ~> m or kg m-2] z_col_new Absolute positions of interfaces [H ~> m or kg m-2] zscale Scaling factor from the input coordinate thicknesses in [Z ~> m] to desired units for zInterface, perhaps GVZ_to_H. h_neglect A negligibly small width for the purpose of cell reconstruction [H ~> m or kg m-2] h_neglect_edge A negligibly small width for the purpose of edge value calculation [H ~> m or kg m-2] regrid_interp::build_and_interpolate_grid mom_regridding::build_grid_hycom1 Regrid columns for the HyCOM coordinate.