mom_ale mom_ale::ale_cs subroutine, public subroutine, public mom_ale::ale_init (param_file, GV, US, max_depth, CS) ale_init param_file param_file GV GV US US max_depth max_depth CS CS This routine is typically called (from initialize_MOM in file MOM.F90) before the main time integration loop to initialize the regridding stuff. We read the MOM_input file to register the values of different regridding/remapping parameters. param_file Parameter file gv Ocean vertical grid structure us A dimensional unit scaling type max_depth The maximum depth of the ocean [Z ~> m]. cs Module control structure ale_initregridding mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_oda_driver_mod::init_oda subroutine, public subroutine, public mom_ale::ale_register_diags (Time, G, GV, US, diag, CS) ale_register_diags Time Time G G GV GV US US diag diag CS CS Initialize diagnostics for the ALE module. time Time structure g Grid structure us A dimensional unit scaling type gv Ocean vertical grid structure diag Diagnostics control structure cs Module control structure mom_verticalgrid::get_thickness_units subroutine, public subroutine, public mom_ale::adjustgridforintegrity (CS, G, GV, h) adjustgridforintegrity CS CS G G GV GV h h Crudely adjust (initial) grid for integrity. This routine is typically called (from initialize_MOM in file MOM.F90) before the main time integration loop to initialize the regridding stuff. We read the MOM_input file to register the values of different regridding/remapping parameters. cs Regridding parameters and options g Ocean grid informations gv Ocean vertical grid structure h Current 3D grid thickness that are to be adjusted [H ~> m or kg-2] subroutine, public subroutine, public mom_ale::ale_end (CS) ale_end CS CS End of regridding (memory deallocation). This routine is typically called (from MOM_end in file MOM.F90) after the main time integration loop to deallocate the regridding stuff. cs module control structure subroutine, public subroutine, public mom_ale::ale_main (G, GV, US, h, u, v, tv, Reg, CS, OBC, dt, frac_shelf_h) ale_main G G GV GV US US h h u u v v tv tv Reg Reg CS CS OBC OBC dt dt frac_shelf_h frac_shelf_h Takes care of (1) building a new grid and (2) remapping all variables between the old grid and the new grid. The creation of the new grid can be based on z coordinates, target interface densities, sigma coordinates or any arbitrary coordinate system. g Ocean grid informations gv Ocean vertical grid structure us A dimensional unit scaling type h Current 3D grid obtained after the last time step [H ~> m or kg m-2] u Zonal velocity field [L T-1 ~> m s-1] v Meridional velocity field [L T-1 ~> m s-1] tv Thermodynamic variable structure reg Tracer registry structure cs Regridding parameters and options obc Open boundary structure dt Time step between calls to ALE_main [T ~> s] frac_shelf_h Fractional ice shelf coverage ale_update_regrid_weights mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_error_handler::calltree_waypoint check_grid mom_diag_mediator::diag_update_remap_grids remap_all_state_vars subroutine, public subroutine, public mom_ale::ale_main_offline (G, GV, h, tv, Reg, CS, OBC, dt) ale_main_offline G G GV GV h h tv tv Reg Reg CS CS OBC OBC dt dt Takes care of (1) building a new grid and (2) remapping all variables between the old grid and the new grid. The creation of the new grid can be based on z coordinates, target interface densities, sigma coordinates or any arbitrary coordinate system. g Ocean grid informations gv Ocean vertical grid structure h Current 3D grid obtained after the last time step [H ~> m or kg-2] tv Thermodynamic variable structure reg Tracer registry structure cs Regridding parameters and options obc Open boundary structure dt Time step between calls to ALE_main [T ~> s] ale_update_regrid_weights mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_error_handler::calltree_waypoint check_grid remap_all_state_vars mom_offline_main::offline_advection_ale subroutine, public subroutine, public mom_ale::ale_offline_inputs (CS, G, GV, h, tv, Reg, uhtr, vhtr, Kd, debug, OBC) ale_offline_inputs CS CS G G GV GV h h tv tv Reg Reg uhtr uhtr vhtr vhtr Kd Kd debug debug OBC OBC Regrid/remap stored fields used for offline tracer integrations. These input fields are assumed to have the same layer thicknesses at the end of the last offline interval (which should be a Zstar grid). This routine builds a grid on the runtime specified vertical coordinate. cs Regridding parameters and options g Ocean grid informations gv Ocean vertical grid structure h Layer thicknesses tv Thermodynamic variable structure reg Tracer registry structure uhtr Zonal mass fluxes vhtr Meridional mass fluxes kd Input diffusivites debug If true, then turn checksums obc Open boundary structure ale_remap_scalar mom_error_handler::calltree_leave mom_error_handler::calltree_waypoint mom_debugging::check_column_integrals check_grid mom_diag_vkernels::interpolate_column mom_tracer_registry::mom_tracer_chkinv mom_diag_vkernels::reintegrate_column remap_all_state_vars mom_offline_main::update_offline_fields subroutine, public subroutine, public mom_ale::ale_offline_tracer_final (G, GV, h, tv, h_target, Reg, CS, OBC) ale_offline_tracer_final G G GV GV h h tv tv h_target h_target Reg Reg CS CS OBC OBC Remaps all tracers from h onto h_target. This is intended to be called when tracers are done offline. In the case where transports don't quite conserve, we still want to make sure that layer thicknesses offline do not drift too far away from the online model. g Ocean grid informations gv Ocean vertical grid structure h Current 3D grid obtained after the last time step [H ~> m or kg-2] tv Thermodynamic variable structure h_target Current 3D grid obtained after last time step [H ~> m or kg-2] reg Tracer registry structure cs Regridding parameters and options obc Open boundary structure mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_error_handler::calltree_waypoint check_grid remap_all_state_vars subroutine subroutine mom_ale::check_grid (G, GV, h, threshold) check_grid G G GV GV h h threshold threshold Check grid for negative thicknesses. g Ocean grid structure gv Ocean vertical grid structure h Current 3D grid obtained after the last time step [H ~> m or kg m-2] threshold Value below which to flag issues, [H ~> m or kg m-2] ale_main ale_main_offline ale_offline_inputs ale_offline_tracer_final subroutine, public subroutine, public mom_ale::ale_build_grid (G, GV, regridCS, remapCS, h, tv, debug, frac_shelf_h) ale_build_grid G G GV GV regridCS regridCS remapCS remapCS h h tv tv debug debug frac_shelf_h frac_shelf_h Generates new grid. g Ocean grid structure gv Ocean vertical grid structure regridcs Regridding parameters and options remapcs Remapping parameters and options tv Thermodynamical variable structure h Current 3D grid obtained after the last time step [H ~> m or kg-2] debug If true, show the call tree frac_shelf_h Fractional ice shelf coverage mom_error_handler::calltree_enter mom_error_handler::calltree_leave subroutine, public subroutine, public mom_ale::ale_regrid_accelerated (CS, G, GV, h, tv, n, u, v, OBC, Reg, dt, dzRegrid, initial) ale_regrid_accelerated CS CS G G GV GV h h tv tv n n u u v v OBC OBC Reg Reg dt dt dzRegrid dzRegrid initial initial For a state-based coordinate, accelerate the process of regridding by repeatedly applying the grid calculation algorithm. cs ALE control structure g Ocean grid gv Vertical grid h Original thicknesses [H ~> m or kg-2] tv Thermo vars (T/S/EOS) n Number of times to regrid u Zonal velocity [L T-1 ~> m s-1] v Meridional velocity [L T-1 ~> m s-1] obc Open boundary structure reg Tracer registry to remap onto new grid dt Model timestep to provide a timescale for regridding [T ~> s] dzregrid Final change in interface positions initial Whether we're being called from an initialization routine (and expect diagnostics to work) ale_update_regrid_weights mom_domains::do_group_pass remap_all_state_vars subroutine subroutine mom_ale::remap_all_state_vars (CS_remapping, CS_ALE, G, GV, h_old, h_new, Reg, OBC, dxInterface, u, v, debug, dt) remap_all_state_vars CS_remapping CS_remapping CS_ALE CS_ALE G G GV GV h_old h_old h_new h_new Reg Reg OBC OBC dxInterface dxInterface u u v v debug debug dt dt This routine takes care of remapping all variable between the old and the new grids. When velocity components need to be remapped, thicknesses at velocity points are taken to be arithmetic averages of tracer thicknesses. This routine is called during initialization of the model at time=0, to remap initiali conditions to the model grid. It is also called during a time step to update the state. cs_remapping Remapping control structure cs_ale ALE control structure g Ocean grid structure gv Ocean vertical grid structure h_old Thickness of source grid [H ~> m or kg-2] h_new Thickness of destination grid [H ~> m or kg-2] reg Tracer registry structure obc Open boundary structure dxinterface Change in interface position u Zonal velocity [L T-1 ~> m s-1] v Meridional velocity [L T-1 ~> m s-1] debug If true, show the call tree dt time step for diagnostics [T ~> s] mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_error_handler::calltree_waypoint mom_open_boundary::obc_direction_n ale_main ale_main_offline ale_offline_inputs ale_offline_tracer_final ale_regrid_accelerated subroutine, public subroutine, public mom_ale::ale_remap_scalar (CS, G, GV, nk_src, h_src, s_src, h_dst, s_dst, all_cells, old_remap, answers_2018) ale_remap_scalar CS CS G G GV GV nk_src nk_src h_src h_src s_src s_src h_dst h_dst s_dst s_dst all_cells all_cells old_remap old_remap answers_2018 answers_2018 Remaps a single scalar between grids described by thicknesses h_src and h_dst. h_dst must be dimensioned as a model array with GVke layers while h_src can have an arbitrary number of layers specified by nk_src. cs Remapping control structure g Ocean grid structure gv Ocean vertical grid structure nk_src Number of levels on source grid h_src Level thickness of source grid [H ~> m or kg-2] s_src Scalar on source grid h_dst Level thickness of destination grid [H ~> m or kg-2] s_dst Scalar on destination grid all_cells If false, only reconstruct for non-vanished cells. Use all vanished layers otherwise (default). old_remap If true, use the old "remapping_core_w" method, otherwise use "remapping_core_h". answers_2018 If true, use the order of arithmetic and expressions that recover the answers for remapping from the end of 2018. Otherwise, use more robust forms of the same expressions. mom_remapping::dzfromh1h2 ale_offline_inputs mom_tracer_initialization_from_z::mom_initialize_tracer_from_z subroutine, public subroutine, public mom_ale::ts_plm_edge_values (CS, S_t, S_b, T_t, T_b, G, GV, tv, h, bdry_extrap) ts_plm_edge_values CS CS S_t S_t S_b S_b T_t T_t T_b T_b G G GV GV tv tv h h bdry_extrap bdry_extrap Calculate edge values (top and bottom of layer) for T and S consistent with a PLM reconstruction in the vertical direction. Boundary reconstructions are PCM unless bdry_extrap is true. g ocean grid structure gv Ocean vertical grid structure cs module control structure s_t Salinity at the top edge of each layer s_b Salinity at the bottom edge of each layer t_t Temperature at the top edge of each layer t_b Temperature at the bottom edge of each layer tv thermodynamics structure h layer thickness [H ~> m or kg m-2] bdry_extrap If true, use high-order boundary extrapolation within boundary cells ale_plm_edge_values mom_pressureforce_fv::pressureforce_fv_bouss mom_pressureforce_fv::pressureforce_fv_nonbouss mom_state_initialization::trim_for_ice subroutine, public subroutine, public mom_ale::ale_plm_edge_values (CS, G, GV, h, Q, bdry_extrap, Q_t, Q_b) ale_plm_edge_values CS CS G G GV GV h h Q Q bdry_extrap bdry_extrap Q_t Q_t Q_b Q_b Calculate edge values (top and bottom of layer) 3d scalar array. Boundary reconstructions are PCM unless bdry_extrap is true. cs module control structure g ocean grid structure gv Ocean vertical grid structure h layer thickness [H ~> m or kg m-2] q 3d scalar array bdry_extrap If true, use high-order boundary extrapolation within boundary cells q_t Scalar at the top edge of each layer q_b Scalar at the bottom edge of each layer plm_functions::plm_extrapolate_slope plm_functions::plm_monotonized_slope plm_functions::plm_slope_wa ts_plm_edge_values subroutine, public subroutine, public mom_ale::ts_ppm_edge_values (CS, S_t, S_b, T_t, T_b, G, GV, tv, h, bdry_extrap) ts_ppm_edge_values CS CS S_t S_t S_b S_b T_t T_t T_b T_b G G GV GV tv tv h h bdry_extrap bdry_extrap Calculate edge values (top and bottom of layer) for T and S consistent with a PPM reconstruction in the vertical direction. Boundary reconstructions are PCM unless bdry_extrap is true. g ocean grid structure gv Ocean vertical grid structure cs module control structure s_t Salinity at the top edge of each layer s_b Salinity at the bottom edge of each layer t_t Temperature at the top edge of each layer t_b Temperature at the bottom edge of each layer tv thermodynamics structure h layer thicknesses [H ~> m or kg m-2] bdry_extrap If true, use high-order boundary extrapolation within boundary cells regrid_edge_values::edge_values_implicit_h4 ppm_functions::ppm_boundary_extrapolation ppm_functions::ppm_reconstruction mom_pressureforce_fv::pressureforce_fv_bouss mom_pressureforce_fv::pressureforce_fv_nonbouss subroutine, public subroutine, public mom_ale::ale_initregridding (GV, US, max_depth, param_file, mdl, regridCS) ale_initregridding GV GV US US max_depth max_depth param_file param_file mdl mdl regridCS regridCS Initializes regridding for the main ALE algorithm. gv Ocean vertical grid structure us A dimensional unit scaling type max_depth The maximum depth of the ocean [Z ~> m]. param_file parameter file mdl Name of calling module regridcs Regridding parameters and work arrays ale_init real function, dimension(cs%nk+1), public real function, dimension(cs%nk+1), public mom_ale::ale_getcoordinate (CS) ale_getcoordinate CS CS Query the target coordinate interfaces positions. cs module control structure character(len=20) function, public character(len=20) function, public mom_ale::ale_getcoordinateunits (CS) ale_getcoordinateunits CS CS Query the target coordinate units. cs module control structure logical function, public logical function, public mom_ale::ale_remap_init_conds (CS) ale_remap_init_conds CS CS Returns true if initial conditions should be regridded and remapped. cs module control structure subroutine, public subroutine, public mom_ale::ale_update_regrid_weights (dt, CS) ale_update_regrid_weights dt dt CS CS Updates the weights for time filtering the new grid generated in regridding. dt Time-step used between ALE calls [T ~> s] cs ALE control structure ale_main ale_main_offline ale_regrid_accelerated subroutine, public subroutine, public mom_ale::ale_updateverticalgridtype (CS, GV) ale_updateverticalgridtype CS CS GV GV Update the vertical grid type with ALE information. This subroutine sets information in the verticalGrid_type to be consistent with the use of ALE mode. cs ALE control structure gv vertical grid information mom_oda_driver_mod::init_oda subroutine, public subroutine, public mom_ale::ale_writecoordinatefile (CS, GV, directory) ale_writecoordinatefile CS CS GV GV directory directory Write the vertical coordinate information into a file. This subroutine writes out a file containing any available data related to the vertical grid used by the MOM ocean model when in ALE mode. cs module control structure gv ocean vertical grid structure directory directory for writing grid info mom_io::create_file subroutine, public subroutine, public mom_ale::ale_initthicknesstocoord (CS, G, GV, h) ale_initthicknesstocoord CS CS G G GV GV h h Set h to coordinate values for fixed coordinate systems. cs module control structure g module grid structure gv Ocean vertical grid structure h layer thickness [H ~> m or kg m-2] mom_regridding::getstaticthickness mom_oda_driver_mod::init_oda This module contains the main regridding routines. Regridding comprises two steps: Interpolation and creation of a new grid based on target interface densities (or any other criterion).Remapping of quantities between old grid and new grid. Original module written by Laurent White, 2008.06.09