mom_error_handler module reference¶

Routines for error handling and I/O management.

Functions/Subroutines¶

`is_root_pe()`	This returns .true.
`mom_mesg()`	This provides a convenient interface for writing an informative comment.
`mom_error()`	This provides a convenient interface for writing an mpp_error message with run-time filter based on a verbosity.
`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.

Detailed Description¶

Routines for error handling and I/O management.

Function/Subroutine Documentation¶

function mom_error_handler/is_root_pe() [logical]¶

This returns .true. if the current PE is the root PE.

Called from: mom_barotropic::btstep calltree_enter calltree_leave calltree_waypoint mom_checksums::chk_sum_msg1 mom_checksums::chk_sum_msg2 mom_checksums::chk_sum_msg3 mom_checksums::chk_sum_msg5 mom_checksums::chk_sum_msg_nsew mom_checksums::chk_sum_msg_s mom_checksums::chk_sum_msg_w mom_checksums::chksum0 mom_checksums::chksum1d mom_checksums::chksum2d mom_checksums::chksum3d mom_checksums::chksum_b_2d mom_checksums::chksum_b_3d mom_checksums::chksum_h_2d mom_checksums::chksum_h_3d mom_checksums::chksum_u_2d mom_checksums::chksum_u_3d mom_checksums::chksum_v_2d mom_checksums::chksum_v_3d mom_file_parser::close_param_file mom_sum_output::depth_list_setup mom_diag_mediator::diag_mediator_init mom_diapyc_energy_req::diapyc_energy_req_test mom_document::doc_closeblock mom_document::doc_function mom_document::doc_module mom_document::doc_openblock mom_document::doc_param_char mom_document::doc_param_int mom_document::doc_param_int_array mom_document::doc_param_logical mom_document::doc_param_logical_array mom_document::doc_param_none mom_document::doc_param_real mom_document::doc_param_real_array mom_document::doc_param_time mom_document::doc_subroutine mom_entrain_diffusive::entrainment_diffusive mom_obsolete_params::find_obsolete_params mom_obsolete_diagnostics::found_in_diagtable mom_ice_shelf::initialize_ice_shelf mom_error mom_main mom_mesg mom_checksum_packages::mom_state_stats mom_tracer_registry::mom_tracer_chkinv mom_write_cputime::mom_write_cputime_end mom_document::open_doc_file mom_file_parser::open_param_file mom_restart::open_restart_units mom_file_parser::populate_param_data mom_restart::query_initialized_0d_name mom_restart::query_initialized_1d_name mom_restart::query_initialized_2d_name mom_restart::query_initialized_3d_name mom_restart::query_initialized_4d_name mom_restart::query_initialized_name mom_diag_mediator::register_diag_field_expand_cmor mom_obsolete_diagnostics::register_obsolete_diagnostics mom_diag_mediator::register_scalar_field mom_diag_mediator::register_static_field mom_restart::restore_state mom_sponge::set_up_sponge_field mom_ice_shelf_dynamics::shelf_advance_front mom_tidal_mixing::tidal_mixing_init mom_debugging::totaltands mom_tracer_registry::tracer_registry_init mom_unit_tests::unit_tests mom_write_cputime::write_cputime mom_sum_output::write_depth_list mom_sum_output::write_energy mom_checksums::zchksum

subroutine mom_error_handler/mom_mesg(message, verb, all_print)¶

This provides a convenient interface for writing an informative comment.

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

is_root_pe verbosity

Called from

subroutine mom_error_handler/mom_error(level, message, all_print)¶

This provides a convenient interface for writing an mpp_error message with run-time filter based on a verbosity.

Parameters

level :: [in] The verbosity 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

is_root_pe verbosity

Called from

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

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 is_root_pe verbosity

Called from

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 is_root_pe verbosity
Called from: mom_ale::ale_build_grid mom_ale::ale_init mom_ale::ale_main mom_ale::ale_main_offline mom_ale::ale_offline_inputs mom_ale::ale_offline_tracer_final 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::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_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_coord_initialization::mom_initialize_coord mom_fixed_initialization::mom_initialize_fixed mom_shared_initialization::mom_initialize_rotation mom_state_initialization::mom_initialize_state mom_tracer_initialization_from_z::mom_initialize_tracer_from_z mom_main ocean_model_mod::ocean_model_init mom_offline_main::offline_transport_init mom_ale::remap_all_state_vars 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::step_mom_thermo mom_tracer_hor_diff::tracer_hordiff ocean_model_mod::update_ocean_model mom_offline_main::update_offline_fields 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 is_root_pe verbosity

Called from

mom_ale::ale_main mom_ale::ale_main_offline mom_ale::ale_offline_inputs mom_ale::ale_offline_tracer_final mom_diabatic_driver::diabatic mom_diabatic_driver::diabatic_ale mom_diabatic_driver::diabatic_ale_legacy mom::initialize_mom mom_diabatic_driver::layered_diabatic mom_main mom_ale::remap_all_state_vars mom_set_diffusivity::set_diffusivity mom::step_mom mom_dynamics_split_rk2::step_mom_dyn_split_rk2 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