mom_error_handler module reference

Routines for error handling and I/O management.

More…

Functions/Subroutines

mom_mesg()	This provides a convenient interface for writing an informative comment, depending on the model’s current verbosity setting and the verbosity level for this message.
disable_fatal_errors()	Enable error handling, replacing FATALs in MOM_error with err_handler.
enable_fatal_errors()	Disable the error handler and abort on FATAL.
set_skip_mpi()	Enable/disable skipping MPI dependent behaviors.
mom_error()	This provides a convenient interface for writing an error message with run-time filter based on a verbosity and the severity of the error.
loc_mom_err()	A private routine through which all error/warning/note messages are written by this module.
mom_set_verbosity()	This subroutine sets the level of verbosity filtering MOM error messages.
mom_get_verbosity()	This subroutine gets the level of verbosity filtering MOM error messages.
mom_verbose_enough()	This tests whether the level of verbosity filtering MOM error messages is sufficient to write a message of verbosity level verb.
calltree_showquery()	Returns True, if the verbosity>=6 indicating to show the call tree.
calltree_enter()	Writes a message about entering a subroutine if call tree reporting is active.
calltree_leave()	Writes a message about leaving a subroutine if call tree reporting is active.
calltree_waypoint()	Writes a message about reaching a milestone if call tree reporting is active.
assert()	Issues a FATAL error if the assertion fails, i.e.
err_handler()	Restore the process state via longjmp after receiving a signal.

Detailed Description

Routines for error handling and I/O management.

Function/Subroutine Documentation

subroutine mom_error_handler/mom_mesg(message, verb, all_print)

This provides a convenient interface for writing an informative comment, depending on the model’s current verbosity setting and the verbosity level for this message.

Parameters:

• message :: [in] A message to write out

• verb :: [in] A level of verbosity for this message

• all_print :: [in] If present and true, any PEs are able to write this message.

Call to:

loc_mom_err skip_mpi_dep verbosity

Called from:

mom_check_scaling::add_scaling adjustment_initialization::adjustment_initialize_thickness mom_barotropic::barotropic_init basin_builder::basin_builder_topography benchmark_initialization::benchmark_initialize_thickness benchmark_initialization::benchmark_initialize_topography mom_barotropic::btstep mom_unique_scales::check_scaling_uniqueness circle_obcs_initialization::circle_obcs_initialize_thickness mom_coriolisadv::coriolisadv_init dome2d_initialization::dome2d_initialize_thickness dome_initialization::dome_initialize_thickness dome_initialization::dome_initialize_topography dumbbell_initialization::dumbbell_initialize_thickness mom_energetic_pbl::energetic_pbl_end mom_energetic_pbl::energetic_pbl_init external_gwave_initialization::external_gwave_initialize_thickness mom_oda_driver_mod::get_posterior_tracer mom_harmonic_analysis::ha_init mom_hor_bnd_diffusion::hor_bnd_diffusion mom_ice_shelf_dynamics::ice_shelf_solve_outer mom_barotropic::initialize_bt_obc mom_ice_shelf_initialize::initialize_ice_aglen mom_ice_shelf_initialize::initialize_ice_c_basal_friction mom_ice_shelf_initialize::initialize_ice_flow_from_file mom_ice_shelf_initialize::initialize_ice_shelf_boundary_channel mom_ice_shelf_initialize::initialize_ice_shelf_boundary_from_file mom_ice_shelf_dynamics::initialize_ice_shelf_dyn mom_ice_shelf_initialize::initialize_ice_smb mom_ice_shelf_initialize::initialize_ice_thickness_channel mom_ice_shelf_initialize::initialize_ice_thickness_from_file mom_open_boundary::initialize_obc_tides mom_open_boundary::initialize_segment_data mom_internal_tides::internal_tides_init isomip_initialization::isomip_initialize_thickness isomip_initialization::isomip_initialize_topography kelvin_initialization::kelvin_initialize_topography lock_exchange_initialization::lock_exchange_initialize_thickness mom_meke::meke_alloc_register_restart mom_meke::meke_init mom6 mom_domains::mom_domains_init mom_grid::mom_grid_init mom_checksum_packages::mom_state_stats neverworld_initialization::neverworld_initialize_thickness neverworld_initialization::neverworld_initialize_topography mom_unique_scales::non_unique_scales mom_opacity::opacity_init mom_coms::reproducing_sum::reproducing_sum_2d mom_coms::reproducing_sum::reproducing_sum_3d rossby_front_2d_initialization::rossby_front_initialize_thickness mom_restart::save_restart seamount_initialization::seamount_initialize_thickness mom_oda_driver_mod::set_analysis_time mom_ice_shelf_dynamics::shelf_advance_front soliton_initialization::soliton_initialize_thickness soliton_initialization::soliton_initialize_velocity mom_tidal_forcing::tidal_forcing_init

subroutine mom_error_handler/disable_fatal_errors(env)

Enable error handling, replacing FATALs in MOM_error with err_handler.

Call to:

err_handler err_pid err_signal ignore_fatal prior_env prior_handler

subroutine mom_error_handler/enable_fatal_errors()

Disable the error handler and abort on FATAL.

Call to:

err_pid err_signal ignore_fatal prior_handler

Called from:

mom_unit_testing::run_unit_test

subroutine mom_error_handler/set_skip_mpi(skip)

Enable/disable skipping MPI dependent behaviors.

Parameters:

skip :: [in] State to assign

Call to:

skip_mpi_dep

subroutine mom_error_handler/mom_error(level, message, all_print)

This provides a convenient interface for writing an error message with run-time filter based on a verbosity and the severity of the error.

Parameters:

• level :: [in] The severity level of this message

• message :: [in] A message to write out

• all_print :: [in] If present and true, any PEs are able to write this message.

Call to:

err_pid err_signal ignore_fatal loc_mom_err skip_mpi_dep posix::sleep verbosity

Called from:

mom_sum_output::accumulate_net_input mom_regridding::adjust_interface_motion adjustment_initialization::adjustment_initialize_temperature_salinity adjustment_initialization::adjustment_initialize_thickness mom_tracer_advect::advect_tracer mom_variables::alloc_bt_cont_type mom_forcing_type::allocate_mech_forcing::allocate_mech_forcing_by_group mom_controlled_forcing::apply_ctrl_forcing mom_surface_forcing_gfdl::apply_force_adjustments mom_oda_incupd::apply_oda_incupd mom_sponge::apply_sponge mom_tracer_diabatic::applytracerboundaryfluxesinout assert mom_remapping::average_value_ppoly mom_barotropic::barotropic_init basin_builder::basin_builder_topography bfb_surface_forcing::bfb_buoyancy_forcing bfb_surface_forcing::bfb_surface_forcing_init mom_bkgnd_mixing::bkgnd_mixing_init mom_hor_bnd_diffusion::boundary_k_range mom_barotropic::bt_mass_source mom_barotropic::btcalc mom_barotropic::btstep mom_barotropic::btstep_timeloop mom_regridding::build_grid_hycom1 mom_remapping::build_reconstructions_1d mom_regridding::build_rho_grid mom_regridding::build_sigma_grid mom_regridding::build_zstar_grid mom_bulk_mixed_layer::bulkmixedlayer mom_bulk_mixed_layer::bulkmixedlayer_init mom_neutral_diffusion::calc_delta_rho_and_derivs mom_lateral_mixing_coeffs::calc_depth_function mom_porous_barriers::calc_eta_at_uv mom_isopycnal_slopes::calc_isoneutral_slopes mom_self_attr_load::calc_love_scaling mom_oda_incupd::calc_oda_increments mom_lateral_mixing_coeffs::calc_qg_slopes mom_lateral_mixing_coeffs::calc_resoln_function mom_lateral_mixing_coeffs::calc_slope_functions mom_lateral_mixing_coeffs::calc_slope_functions_using_just_e mom_lateral_mixing_coeffs::calc_sqg_struct mom_lateral_mixing_coeffs::calc_visbeck_coeffs_old mom_tidal_mixing::calculate_cvmix_tidal mom_diagnostics::calculate_diagnostic_fields mom_boundary_update::call_obc_register mom_tracer_flow_control::call_tracer_column_fns mom_tracer_flow_control::call_tracer_register mom_tracer_flow_control::call_tracer_set_forcing mom_tracer_flow_control::call_tracer_stocks mom_tracer_flow_control::call_tracer_surface_state mom_bkgnd_mixing::check_bkgnd_scheme mom_regridding::check_grid_column mom_surface_forcing_gfdl::check_mask_val_consistency mom_netcdf::check_netcdf_call mom_remapping::check_reconstructions_1d mom_debugging::check_redundant_b::check_redundant_sb2d mom_debugging::check_redundant_b::check_redundant_vb2d mom_debugging::check_redundant::check_redundant_vc2d mom_remapping::check_remapped_values mom_checksums::chksum_error mom_io::close_file_to_read marbl_interface::compute_totchl marbl_tracers::configure_marbl_tracers mom_continuity_ppm::continuity_ppm marbl_forcing_mod::convert_driver_fields_to_forcings mom_interface_heights::convert_mld_to_ml_thickness regrid_consts::coordinatemode regrid_consts::coordinateunits::coordinateunitsi mom_transcribe_grid::copy_dyngrid_to_mom_grid mom_transcribe_grid::copy_mom_grid_to_dyngrid mom_restart::copy_restart_var::copy_restart_var_3d mom_restart::copy_restart_vector::copy_restart_vector_3d mom_coriolisadv::coradcalc mom_coriolisadv::coriolisadv_init mom_internal_tides::correct_halo_rotation mom_regridding::create_coord_param mom_dyn_horgrid::create_dyn_horgrid mom_io::create_mom_file mom_cvmix_conv::cvmix_conv_init mom_cvmix_ddiff::cvmix_ddiff_init mom_cvmix_shear::cvmix_shear_init mom_database_comms::database_comms_init mom_is_diag_mediator::defineaxes dense_water_initialization::dense_water_initialize_sponges mom_sum_output::depth_list_setup mom_dyn_horgrid::destroy_dyn_horgrid mom_entrain_diffusive::determine_dskb mom_entrain_diffusive::determine_ea_kb mom_restart::determine_is_new_run mom_domains::determine_land_blocks mom_obsolete_diagnostics::diag_found mom_diag_remap::diag_remap_update mom_diagnose_mld::diagnosemldbydensitydifference mom_diapyc_energy_req::diapyc_energy_req_test mom_offline_aux::distribute_residual_uh_barotropic mom_offline_aux::distribute_residual_uh_upwards mom_offline_aux::distribute_residual_vh_barotropic mom_offline_aux::distribute_residual_vh_upwards dome2d_initialization::dome2d_initialize_sponges dome2d_initialization::dome2d_initialize_temperature_salinity dome2d_initialization::dome2d_initialize_thickness dome_initialization::dome_initialize_sponges dome_initialization::dome_initialize_topography dome_initialization::dome_set_obc_data dumbbell_initialization::dumbbell_initialize_temperature_salinity dumbbell_surface_forcing::dumbbell_surface_forcing_init dyed_channel_initialization::dyed_channel_set_obc_tracer_data dyed_channel_initialization::dyed_channel_update_flow dyed_obcs_initialization::dyed_obcs_set_obc_data mom_regridding::dz_function1 mom_coms::efp_sum_across_pes::efp_list_sum_across_pes mom_coms::efp_sum_across_pes::efp_val_sum_across_pes mom_energetic_pbl::energetic_pbl mom_energetic_pbl::energetic_pbl_init mom_io::ensembler mom_entrain_diffusive::entrainment_diffusive mom_tidal_forcing::eq_phase mom_surface_forcing_gfdl::extract_iob_stresses mom_forcing_type::extractfluxes1d mom_checksums::rotated_field_chksum::field_checksum_real_0d mom_checksums::rotated_field_chksum::field_checksum_real_1d mom_io::field_size mom_streaming_filter::filt_init mom_streaming_filter::filt_register mom_regridding::filtered_grid_motion mom_interface_heights::find_col_avg_spv mom_density_integrals::find_depth_of_pressure_in_cell mom_interface_heights::find_eta::find_eta_3d mom_tidal_forcing::find_in_files mom_neutral_diffusion::find_neutral_pos_linear mom_neutral_diffusion::find_neutral_surface_positions_discontinuous mom_obsolete_params::find_obsolete_params mom_interface_heights::find_rho_bottom mom_document::find_unused_unit_number mom_forcing_type::find_ustar::find_ustar_fluxes mom_forcing_type::find_ustar::find_ustar_mech_forcing mom_forcing_type::fluxes_accumulate mom_domains::gen_auto_mask_table mom_geothermal::geothermal_entraining mom_geothermal::geothermal_in_place mom_geothermal::geothermal_init mom_ale_sponge::get_ale_sponge_thicknesses mom_restart::get_checksum_loop_ranges mom_tracer_flow_control::get_chl_from_model mom_hybgen_regrid::get_hybgen_regrid_params mom_wave_interface::get_langmuir_number mom_internal_tides::get_lowmode_diffusivity mom_get_input::get_mom_input mom_restart::get_num_restart_files regrid_interp::get_polynomial_coordinate marbl_interface::get_setting mom_verticalgrid::get_tr_flux_units mom_io::get_var_axes_info mom_io::get_varid mom_regridding::getcoordinateinterfaces mom_regridding::getcoordinateshortname mom_regridding::getcoordinateunits mom_regridding::getstaticthickness mom_spatial_means::global_i_mean mom_spatial_means::global_j_mean mom_harmonic_analysis::ha_accum_ftssh mom_harmonic_analysis::ha_init mom_hor_bnd_diffusion::hbd_grid mom_hor_bnd_diffusion::hbd_grid_test mom_hor_bnd_diffusion::hor_bnd_diffusion mom_hor_bnd_diffusion::hor_bnd_diffusion_init mom_hor_visc::hor_visc_init mom_hor_visc::horizontal_viscosity mom_hybgen_regrid::hybgen_column_regrid mom_hybgen_unmix::hybgen_unmix mom_ice_shelf_dynamics::ice_shelf_advect mom_ice_shelf_state::ice_shelf_state_init ideal_age_example::ideal_age_tracer_column_physics idealized_hurricane::idealized_hurricane_wind_forcing idealized_hurricane::idealized_hurricane_wind_init mom_neutral_diffusion::increment_interface marbl_interface::init coord_adapt::init_coord_adapt coord_hycom::init_coord_hycom coord_rho::init_coord_rho coord_sigma::init_coord_sigma coord_zlike::init_coord_zlike mom_hybgen_regrid::init_hybgen_regrid mom_hybgen_unmix::init_hybgen_unmix mom_oda_driver_mod::init_oda mom_opacity::init_ohlmann_table stochastic_physics::init_stochastic_physics_ocn mom_cfc_cap::init_tracer_cfc mom_ocmip2_cfc::init_tracer_cfc mom_ale_sponge::initialize_ale_sponge::initialize_ale_sponge_fixed mom_ale_sponge::initialize_ale_sponge::initialize_ale_sponge_varying dome_tracer::initialize_dome_tracer dyed_obc_tracer::initialize_dyed_obc_tracer mom_dynamics_unsplit::initialize_dyn_unsplit mom_ice_shelf_initialize::initialize_ice_aglen mom_ice_shelf_initialize::initialize_ice_c_basal_friction mom_ice_shelf_initialize::initialize_ice_flow_from_file mom_ice_shelf_initialize::initialize_ice_shelf_boundary_from_file mom_ice_shelf_dynamics::initialize_ice_shelf_dyn mom_ice_shelf_initialize::initialize_ice_smb mom_ice_shelf_initialize::initialize_ice_thickness mom_ice_shelf_initialize::initialize_ice_thickness_from_file ideal_age_example::initialize_ideal_age_tracer isomip_tracer::initialize_isomip_tracer marbl_tracers::initialize_marbl_tracers nw2_tracers::initialize_nw2_tracers mom_oda_incupd::initialize_oda_incupd mom_oda_incupd::initialize_oda_incupd_fixed oil_tracer::initialize_oil_tracer mom_regridding::initialize_regridding rgc_tracer::initialize_rgc_tracer mom_open_boundary::initialize_segment_data mom_sponge::initialize_sponge mom_density_integrals::int_density_dz_generic_pcm mom_density_integrals::int_spec_vol_dp_generic_pcm mom_density_integrals::int_spec_vol_dp_generic_plm mom_int_tide_input::int_tide_input_init mom_interface_filter::interface_filter mom_interface_filter::interface_filter_init marbl_interface::interior_tendency_compute mom_internal_tides::internal_tides_init mom_neutral_diffusion::interpolate_for_nondim_position regrid_interp::interpolation_scheme interpret_int_expr mom_restart::is_new_run isomip_initialization::isomip_initialize_sponges isomip_initialization::isomip_initialize_temperature_salinity isomip_initialization::isomip_initialize_thickness isomip_initialization::isomip_initialize_topography mom_kappa_shear::kappa_shear_init kelvin_initialization::kelvin_set_obc_data mom_cvmix_kpp::kpp_calculate mom_cvmix_kpp::kpp_compute_bld mom_cvmix_kpp::kpp_init regrid_solvers::linear_solver mom_restart::lock_check mom_tracer_registry::lock_tracer_registry marbl_forcing_mod::marbl_forcing_init marbl_tracers::marbl_tracers_column_physics marbl_tracers::marbl_tracers_get mom_marine_ice::marine_ice_init mom_meke::meke_init mom_document::mesghasbeendocumented meso_surface_forcing::meso_buoyancy_forcing meso_surface_forcing::meso_surface_forcing_init mom_bulk_mixed_layer::mixedlayer_detrain_1 mom_bulk_mixed_layer::mixedlayer_detrain_2 mom_mixed_layer_restrat::mixedlayer_restrat mom_mixed_layer_restrat::mixedlayer_restrat_bodner mom_mixed_layer_restrat::mixedlayer_restrat_om4 mom_meke::ml_meke_init mom_io::modify_vardesc mom6 mom_domains::mom_domains_init mom_grid::mom_grid_init mom_is_diag_mediator::mom_is_diag_mediator_init mom_set_verbosity mom_stoch_eos::mom_stoch_eos_init mom_sum_output::mom_sum_output_init mom_wave_interface::mom_wave_interface_init mom_neutral_diffusion::neutral_diffusion_calc_coeffs mom_neutral_diffusion::neutral_diffusion_init mom_neutral_diffusion::neutral_surface_t_eval mom_tidal_forcing::nodal_fu mom_io::num_timelevels nw2_tracers::nw2_tracer_column_physics mom_obsolete_params::obsolete_char mom_obsolete_params::obsolete_int mom_obsolete_params::obsolete_logical mom_obsolete_params::obsolete_real mom_opacity::opacity_from_chl mom_opacity::opacity_init mom_open_boundary::open_boundary_config mom_document::open_doc_file mom_io::open_file_to_read mom_netcdf::open_netcdf_file mom_restart::open_restart_units mom_oda_incupd::output_oda_incupd_inc mom_open_boundary::parse_segment_data_str mom_open_boundary::parse_segment_str phillips_initialization::phillips_initialize_sponges phillips_initialization::phillips_initialize_thickness phillips_initialization::phillips_initialize_velocity mom_porous_barriers::porous_barriers_init mom_porous_barriers::porous_widths_interface mom_porous_barriers::porous_widths_layer mom_is_diag_mediator::post_is_data mom_tracer_registry::postale_tracer_diagnostics mom_internal_tides::ppm_reconstruction_x mom_continuity_ppm::ppm_reconstruction_x mom_internal_tides::ppm_reconstruction_y mom_continuity_ppm::ppm_reconstruction_y mom_meke::predict_meke mom_pressureforce_fv::pressureforce_fv_bouss mom_pressureforce_fv::pressureforce_fv_init mom_pressureforce_fv::pressureforce_fv_nonbouss mom_pressureforce_mont::pressureforce_mont_bouss mom_pressureforce_mont::pressureforce_mont_nonbouss marbl_tracers::print_marbl_log mom_internal_tides::propagate_int_tide marbl_interface::put_setting mom_restart::query_initialized::query_initialized_0d mom_restart::query_initialized::query_initialized_0d_name mom_restart::query_initialized::query_initialized_1d mom_restart::query_initialized::query_initialized_1d_name mom_restart::query_initialized::query_initialized_2d mom_restart::query_initialized::query_initialized_2d_name mom_restart::query_initialized::query_initialized_3d mom_restart::query_initialized::query_initialized_3d_name mom_restart::query_initialized::query_initialized_4d mom_restart::query_initialized::query_initialized_4d_name mom_restart::query_initialized::query_initialized_name mom_wave_interface::query_wave_properties mom_io::read_attribute::read_attribute_int32 mom_io::read_attribute::read_attribute_int64 mom_io::read_attribute::read_attribute_real mom_io::read_attribute::read_attribute_str mom_sum_output::read_depth_list mom_io::read_netcdf_data::read_netcdf_data_2d mom_tidal_mixing::read_tidal_constituents mom_tidal_mixing::read_tidal_energy mom_io::read_var_sizes mom_io::read_variable::read_variable_0d mom_io::read_variable::read_variable_0d_int mom_io::read_variable::read_variable_1d mom_io::read_variable::read_variable_1d_int mom_io::read_variable::read_variable_2d mom_io::read_variable::read_variable_3d mom_tracer_z_init::read_z_edges mom_coms::real_to_efp mom_coms::real_to_ints mom_internal_tides::refract advection_test_tracer::register_advection_test_tracer boundary_impulse_tracer::register_boundary_impulse_tracer mom_cfc_cap::register_cfc_cap mom_controlled_forcing::register_ctrl_forcing_restarts dome_initialization::register_dome_obc dome_tracer::register_dome_tracer regional_dyes::register_dye_tracer dyed_channel_initialization::register_dyed_channel_obc dyed_obc_tracer::register_dyed_obc_tracer mom_ice_shelf_dynamics::register_ice_shelf_dyn_restarts ideal_age_example::register_ideal_age_tracer mom_internal_tides::register_int_tide_restarts isomip_tracer::register_isomip_tracer kelvin_initialization::register_kelvin_obc mom_cvmix_kpp::register_kpp_restarts marbl_tracers::register_marbl_tracers mom_generic_tracer::register_mom_generic_tracer mom_is_diag_mediator::register_mom_is_diag_field mom_netcdf::register_netcdf_axis mom_netcdf::register_netcdf_field nw2_tracers::register_nw2_tracers mom_obsolete_diagnostics::register_obsolete_diagnostics mom_ocmip2_cfc::register_ocmip2_cfc oil_tracer::register_oil_tracer pseudo_salt_tracer::register_pseudo_salt_tracer mom_restart::register_restart_field::register_restart_field_0d mom_restart::register_restart_field::register_restart_field_1d mom_restart::register_restart_field::register_restart_field_2d mom_restart::register_restart_field::register_restart_field_3d mom_restart::register_restart_field::register_restart_field_4d mom_restart::register_restart_field::register_restart_field_ptr0d mom_restart::register_restart_field::register_restart_field_ptr1d mom_restart::register_restart_field::register_restart_field_ptr2d mom_restart::register_restart_field::register_restart_field_ptr3d mom_restart::register_restart_field::register_restart_field_ptr4d mom_dynamics_unsplit::register_restarts_dyn_unsplit rgc_tracer::register_rgc_tracer shelfwave_initialization::register_shelfwave_obc mom_diagnostics::register_time_deriv mom_tracer_registry::register_tracer mom_tracer_registry::register_tracer_diagnostics mom_regridding::regridding_main mom_regridding::regridding_preadjust_reqs mom_regularize_layers::regularize_layers mom_regularize_layers::regularize_surface mom_remapping::remapping_set_param mom_io::reopen_mom_file mom_coms::reproducing_sum_efp::reproducing_efp_sum_2d mom_coms::reproducing_sum::reproducing_sum_2d mom_coms::reproducing_sum::reproducing_sum_3d mom_dyn_horgrid::rescale_dyn_horgrid_bathymetry mom_restart::restart_error mom_restart::restart_files_exist mom_restart::restart_init mom_restart::restore_state rgc_initialization::rgc_initialize_sponges rossby_front_2d_initialization::rossby_front_initialize_temperature_salinity rossby_front_2d_initialization::rossby_front_initialize_thickness rossby_front_2d_initialization::rossby_front_initialize_velocity mom_ale_sponge::rotate_ale_sponge mom_io::safe_string_copy mom_self_attr_load::sal_init mom_restart::save_restart scm_cvmix_tests::scm_cvmix_tests_surface_forcing_init seamount_initialization::seamount_initialize_temperature_salinity coord_adapt::set_adapt_params mom_oda_driver_mod::set_analysis_time mom_io::set_axis_info mom_barotropic::set_dtbt mom_hybgen_unmix::set_hybgen_unmix_params coord_hycom::set_hycom_params mom_restart::set_initialized::set_initialized_0d_name mom_restart::set_initialized::set_initialized_1d_name mom_restart::set_initialized::set_initialized_2d_name mom_restart::set_initialized::set_initialized_3d_name mom_restart::set_initialized::set_initialized_4d_name mom_restart::set_initialized::set_initialized_name mom_int_tide_input::set_int_tide_input mom_oda_driver_mod::set_prior_tracer mom_regridding::set_regrid_max_depths mom_regridding::set_regrid_params coord_rho::set_rho_params marbl_tracers::set_riv_flux_tracer_inds coord_sigma::set_sigma_params mom_regridding::set_target_densities mom_tracer_advect_schemes::set_tracer_advect_scheme mom_ale_sponge::set_up_ale_sponge_field::set_up_ale_sponge_field_fixed mom_ale_sponge::set_up_ale_sponge_field::set_up_ale_sponge_field_varying mom_oda_incupd::set_up_oda_incupd_field mom_sponge::set_up_sponge_field mom_sponge::set_up_sponge_ml_density mom_set_visc::set_visc_init mom_set_visc::set_viscous_bbl mom_set_visc::set_viscous_ml coord_zlike::set_zlike_params mom_regridding::setcoordinateresolution mom_remapping::setreconstructiontype marbl_tracers::setup_saved_state mom_tidal_mixing::setup_tidal_diagnostics mom_open_boundary::setup_u_point_obc mom_open_boundary::setup_v_point_obc mom_ice_shelf_dynamics::shelf_advance_front shelfwave_initialization::shelfwave_set_obc_data marbl_interface::shutdown soliton_initialization::soliton_initialize_thickness soliton_initialization::soliton_initialize_velocity regrid_solvers::solve_linear_system mom_spherical_harmonics::spherical_harmonics_forward mom_spherical_harmonics::spherical_harmonics_inverse regrid_consts::state_dependent::state_dependent_int mom_meke::step_forward_meke mom_tracer_flow_control::store_stocks supercritical_initialization::supercritical_set_obc_data mom_wave_interface::surface_bands_by_data_override marbl_interface::surface_flux_compute mom_surface_forcing_gfdl::surface_forcing_init mom_internal_tides::teleport regrid_edge_values::test_line mom_neutral_diffusion::test_nsp mom_thickness_diffuse::thickness_diffuse mom_thickness_diffuse::thickness_diffuse_full mom_thickness_diffuse::thickness_diffuse_init mom_interface_heights::thickness_to_dz::thickness_to_dz_3d mom_interface_heights::thickness_to_dz::thickness_to_dz_jslice mom_tidal_forcing::tidal_forcing_init mom_tidal_forcing::tidal_frequency mom_tidal_mixing::tidal_mixing_init mom_interpolate::time_interp_external::time_interp_external_2d mom_interpolate::time_interp_external::time_interp_external_3d mom_tracer_advect::tracer_advect_init mom_tracer_flow_control::tracer_flow_control_init mom_tracer_registry::tracer_name_lookup mom_tracer_registry::tracer_registry_init mom_tracer_diabatic::tracer_vertdiff mom_tracer_diabatic::tracer_vertdiff_eulerian mom_tracer_z_init::tracer_z_init mom_regridding::uniformresolution mom_hor_bnd_diffusion::unique mom_unit_scaling::unit_no_scaling_init mom_unit_scaling::unit_scaling_init mom_unit_tests::unit_tests mom_offline_aux::update_offline_from_arrays mom_wave_interface::update_surface_waves mom_vert_friction::updatecfltruncationvalue user_surface_forcing::user_buoyancy_forcing user_change_diffusivity::user_change_diff user_change_diffusivity::user_change_diff_init user_initialization::user_init_temperature_salinity user_initialization::user_initialize_sponges user_initialization::user_initialize_thickness user_initialization::user_initialize_topography user_tracer_example::user_initialize_tracer user_initialization::user_initialize_velocity user_tracer_example::user_register_tracer_example user_initialization::user_set_coord user_initialization::user_set_rotation user_surface_forcing::user_surface_forcing_init user_surface_forcing::user_wind_forcing mom_wave_interface::ust_2_u10_coare3p5 mom_lateral_mixing_coeffs::varmix_init mom_verticalgrid::verticalgridinit mom_vert_friction::vertvisc mom_vert_friction::vertvisc_coef mom_vert_friction::vertvisc_init mom_vert_friction::vertvisc_remnant mom_ice_shelf_dynamics::volume_above_floatation mom_wave_drag::wave_drag_init mom_wave_speed::wave_speed mom_wave_speed::wave_speeds mom_wave_interface::waves_register_restarts mom_write_cputime::write_cputime mom_sum_output::write_energy mom_pointaccel::write_u_accel mom_pointaccel::write_v_accel

subroutine mom_error_handler/loc_mom_err(level, message)

A private routine through which all error/warning/note messages are written by this module.

Parameters:

• level :: [in] The severity level of this message

• message :: [in] A message to write out

Call to:

skip_mpi_dep

Called from:

calltree_enter calltree_leave calltree_waypoint mom_error mom_mesg

subroutine mom_error_handler/mom_set_verbosity(verb)

This subroutine sets the level of verbosity filtering MOM error messages.

Parameters:

verb :: [in] A level of verbosity to set

Call to:

mom_error verbosity

function mom_error_handler/mom_get_verbosity() [integer]

This subroutine gets the level of verbosity filtering MOM error messages.

Call to:

verbosity

Called from:

mom_unique_scales::check_scaling_uniqueness mom_horizontal_regridding::horiz_interp_and_extrap_tracer::horiz_interp_and_extrap_tracer_fms_id mom_restart::save_restart

function mom_error_handler/mom_verbose_enough(verb) [logical]

This tests whether the level of verbosity filtering MOM error messages is sufficient to write a message of verbosity level verb.

Parameters:

verb :: [in] A level of verbosity to test

Call to:

verbosity

function mom_error_handler/calltree_showquery() [logical]

Returns True, if the verbosity>=6 indicating to show the call tree.

Call to:

verbosity

subroutine mom_error_handler/calltree_enter(mesg, n)

Writes a message about entering a subroutine if call tree reporting is active.

Parameters:

• mesg :: [in] Message to write

• n :: [in] An optional integer to write at end of message

Call to:

calltreeindentlevel loc_mom_err verbosity

Called from:

mom_ale::ale_init mom_ale::ale_regrid mom::ale_regridding_and_remapping mom_ale::ale_remap_set_h_vel mom_ale::ale_remap_set_h_vel_via_dz mom_ale::ale_remap_tracers mom_ale::ale_remap_velocities mom_stochastics::apply_skeb mom_shared_initialization::apply_topography_edits_from_file mom_surface_forcing::buoyancy_forcing_const mom_surface_forcing::buoyancy_forcing_from_data_override mom_surface_forcing::buoyancy_forcing_from_files mom_surface_forcing::buoyancy_forcing_linear mom_surface_forcing::buoyancy_forcing_zero mom_diabatic_driver::diabatic_ale mom_diabatic_driver::diabatic_ale_legacy mom_diag_mediator::diag_update_remap_grids mom::extract_surface_state mom::finish_mom_initialization mom_grid_initialize::initialize_masks mom::initialize_mom mom_state_initialization::initialize_thickness_from_file mom_state_initialization::initialize_thickness_list mom_state_initialization::initialize_thickness_param mom_state_initialization::initialize_thickness_uniform mom_shared_initialization::initialize_topography_from_file mom_shared_initialization::initialize_topography_named mom_state_initialization::initialize_velocity_from_file mom_state_initialization::initialize_velocity_zero mom_diabatic_driver::layered_diabatic mom_shared_initialization::limit_topography mom_surface_forcing::marbl_forcing_from_data_override mom6 mom_shared_initialization::mom_calculate_grad_coriolis mom_coord_initialization::mom_initialize_coord mom_fixed_initialization::mom_initialize_fixed mom_state_initialization::mom_initialize_obcs mom_shared_initialization::mom_initialize_rotation mom_state_initialization::mom_initialize_state mom_tracer_initialization_from_z::mom_initialize_tracer_from_z ocean_model_mod::ocean_model_init mom_offline_main::offline_transport_init mom_diag_mediator::post_data::post_data_3d mom::post_diabatic_halo_updates mom_shared_initialization::reset_face_lengths_file mom_shared_initialization::reset_face_lengths_list mom_coord_initialization::set_coord_from_file mom_coord_initialization::set_coord_from_gprime mom_coord_initialization::set_coord_from_layer_density mom_coord_initialization::set_coord_from_ts_profile mom_coord_initialization::set_coord_from_ts_range mom_coord_initialization::set_coord_from_ts_ref mom_coord_initialization::set_coord_linear mom_coord_initialization::set_coord_to_none mom_set_diffusivity::set_diffusivity mom_surface_forcing::set_forcing mom_grid_initialize::set_grid_metrics mom_grid_initialize::set_grid_metrics_cartesian mom_grid_initialize::set_grid_metrics_from_mosaic mom_grid_initialize::set_grid_metrics_mercator mom_grid_initialize::set_grid_metrics_spherical mom_shared_initialization::set_rotation_beta_plane mom_shared_initialization::set_rotation_planetary mom::step_mom mom_dynamics_split_rk2::step_mom_dyn_split_rk2 mom_dynamics_split_rk2b::step_mom_dyn_split_rk2b mom::step_mom_thermo mom_stochastics::stochastics_init mom_tracer_hor_diff::tracer_hordiff ocean_model_mod::update_ocean_model mom_offline_main::update_offline_fields mom_stochastics::update_stochastics mom_surface_forcing::wind_forcing_1gyre mom_surface_forcing::wind_forcing_2gyre mom_surface_forcing::wind_forcing_by_data_override mom_surface_forcing::wind_forcing_const mom_surface_forcing::wind_forcing_from_file mom_surface_forcing::wind_forcing_gyres

subroutine mom_error_handler/calltree_leave(mesg)

Writes a message about leaving a subroutine if call tree reporting is active.

Parameters:

mesg :: Message to write

Call to:

calltreeindentlevel loc_mom_err verbosity

Called from:

mom_ale::ale_init mom_ale::ale_offline_inputs mom_ale::ale_regrid mom::ale_regridding_and_remapping mom_ale::ale_remap_set_h_vel mom_ale::ale_remap_set_h_vel_via_dz mom_ale::ale_remap_tracers mom_ale::ale_remap_velocities mom_stochastics::apply_skeb mom_shared_initialization::apply_topography_edits_from_file mom_surface_forcing::buoyancy_forcing_const mom_surface_forcing::buoyancy_forcing_from_data_override mom_surface_forcing::buoyancy_forcing_from_files mom_surface_forcing::buoyancy_forcing_linear mom_surface_forcing::buoyancy_forcing_zero mom_diabatic_driver::diabatic_ale mom_diabatic_driver::diabatic_ale_legacy mom_diag_mediator::diag_update_remap_grids mom::extract_surface_state mom::finish_mom_initialization mom_grid_initialize::initialize_masks mom::initialize_mom mom_state_initialization::initialize_thickness_from_file mom_state_initialization::initialize_thickness_list mom_state_initialization::initialize_thickness_param mom_state_initialization::initialize_thickness_uniform mom_shared_initialization::initialize_topography_from_file mom_shared_initialization::initialize_topography_named mom_state_initialization::initialize_velocity_from_file mom_state_initialization::initialize_velocity_zero mom_diabatic_driver::layered_diabatic mom_shared_initialization::limit_topography mom_surface_forcing::marbl_forcing_from_data_override mom6 mom_shared_initialization::mom_calculate_grad_coriolis mom_coord_initialization::mom_initialize_coord mom_fixed_initialization::mom_initialize_fixed mom_state_initialization::mom_initialize_obcs mom_shared_initialization::mom_initialize_rotation mom_state_initialization::mom_initialize_state mom_tracer_initialization_from_z::mom_initialize_tracer_from_z ocean_model_mod::ocean_model_init mom_offline_main::offline_transport_init mom_diag_mediator::post_data::post_data_3d mom::post_diabatic_halo_updates mom_shared_initialization::reset_face_lengths_file mom_shared_initialization::reset_face_lengths_list mom_coord_initialization::set_coord_from_file mom_coord_initialization::set_coord_from_gprime mom_coord_initialization::set_coord_from_layer_density mom_coord_initialization::set_coord_from_ts_profile mom_coord_initialization::set_coord_from_ts_range mom_coord_initialization::set_coord_from_ts_ref mom_coord_initialization::set_coord_linear mom_coord_initialization::set_coord_to_none mom_set_diffusivity::set_diffusivity mom_surface_forcing::set_forcing mom_grid_initialize::set_grid_metrics mom_grid_initialize::set_grid_metrics_cartesian mom_grid_initialize::set_grid_metrics_from_mosaic mom_grid_initialize::set_grid_metrics_mercator mom_grid_initialize::set_grid_metrics_spherical mom_shared_initialization::set_rotation_beta_plane mom_shared_initialization::set_rotation_planetary mom::step_mom mom_dynamics_split_rk2::step_mom_dyn_split_rk2 mom_dynamics_split_rk2b::step_mom_dyn_split_rk2b mom::step_mom_thermo mom_stochastics::stochastics_init mom_surface_forcing::surface_forcing_end mom_tracer_hor_diff::tracer_hordiff ocean_model_mod::update_ocean_model mom_offline_main::update_offline_fields mom_stochastics::update_stochastics mom_surface_forcing::wind_forcing_1gyre mom_surface_forcing::wind_forcing_2gyre mom_surface_forcing::wind_forcing_by_data_override mom_surface_forcing::wind_forcing_const mom_surface_forcing::wind_forcing_from_file mom_surface_forcing::wind_forcing_gyres

subroutine mom_error_handler/calltree_waypoint(mesg, n)

Writes a message about reaching a milestone if call tree reporting is active.

Parameters:

• mesg :: [in] Message to write

• n :: [in] An optional integer to write at end of message

Call to:

calltreeindentlevel loc_mom_err verbosity

Called from:

mom_ale::ale_offline_inputs mom::ale_regridding_and_remapping mom_ale::ale_remap_tracers mom_ale::ale_remap_velocities mom_diabatic_driver::diabatic mom_diabatic_driver::diabatic_ale mom_diabatic_driver::diabatic_ale_legacy mom_ice_shelf::initialize_ice_shelf mom::initialize_mom mom_diabatic_driver::layered_diabatic mom6 mom::save_mom_restart mom_set_diffusivity::set_diffusivity mom::step_mom mom_dynamics_split_rk2::step_mom_dyn_split_rk2 mom_dynamics_split_rk2b::step_mom_dyn_split_rk2b mom::step_mom_dynamics mom::step_mom_thermo mom::step_mom_tracer_dyn mom_tracer_hor_diff::tracer_hordiff

subroutine mom_error_handler/assert(logical_arg, msg)

Issues a FATAL error if the assertion fails, i.e. the first argument is false.

Parameters:

• logical_arg :: [in] If false causes a FATAL error

• msg :: [in] Message to issue in case of failed assertion

Call to:

mom_error

Called from:

mom_regridding::build_grid_adaptive mom_unique_scales::check_scaling_uniqueness mom_diag_remap::diag_remap_calc_hmask mom_diag_remap::diag_remap_do_remap mom_diag_remap::do_remap mom_is_diag_mediator::get_new_diag_id mom_diag_remap::horizontally_average_field mom_unique_scales::non_unique_scales mom_is_diag_mediator::post_is_data mom_is_diag_mediator::post_is_data_0d mom_diag_remap::vertically_interpolate_diag_field mom_diag_remap::vertically_interpolate_field mom_diag_remap::vertically_reintegrate_diag_field mom_diag_remap::vertically_reintegrate_field

subroutine mom_error_handler/err_handler(sig)

Restore the process state via longjmp after receiving a signal.

Parameters:

sig :: [in] Signal passed to the handler (unused)

Call to:

prior_env

Called from:

disable_fatal_errors