mom_restart mom_restart::field_restart mom_restart::mom_restart_cs mom_restart::obsolete_restart mom_restart::p0d mom_restart::p1d mom_restart::p2d mom_restart::p3d mom_restart::p4d mom_restart::query_initialized mom_restart::register_restart_field mom_restart::register_restart_pair subroutine, public subroutine, public mom_restart::register_restart_field_as_obsolete (field_name, replacement_name, CS) register_restart_field_as_obsolete field_name field_name replacement_name replacement_name CS CS field_name Name of restart field that is no longer in use replacement_name Name of replacement restart field, if applicable cs A pointer to a MOM_restart_CS object (intent in/out) mom_set_visc::set_visc_init subroutine subroutine mom_restart::register_restart_field_ptr3d (f_ptr, var_desc, mandatory, CS) register_restart_field_ptr3d f_ptr f_ptr var_desc var_desc mandatory mandatory CS CS Register a 3-d field for restarts, providing the metadata in a structure. f_ptr A pointer to the field to be read or written var_desc A structure with metadata about this variable mandatory If true, the run will abort if this field is not successfully read from the restart file. cs A pointer to a MOM_restart_CS object (intent in/out) mom_error_handler::mom_error register_restart_field_3d subroutine subroutine mom_restart::register_restart_field_ptr4d (f_ptr, var_desc, mandatory, CS) register_restart_field_ptr4d f_ptr f_ptr var_desc var_desc mandatory mandatory CS CS Register a 4-d field for restarts, providing the metadata in a structure. f_ptr A pointer to the field to be read or written var_desc A structure with metadata about this variable mandatory If true, the run will abort if this field is not successfully read from the restart file. cs A pointer to a MOM_restart_CS object (intent in/out) mom_error_handler::mom_error register_restart_field_4d subroutine subroutine mom_restart::register_restart_field_ptr2d (f_ptr, var_desc, mandatory, CS) register_restart_field_ptr2d f_ptr f_ptr var_desc var_desc mandatory mandatory CS CS Register a 2-d field for restarts, providing the metadata in a structure. f_ptr A pointer to the field to be read or written var_desc A structure with metadata about this variable mandatory If true, the run will abort if this field is not successfully read from the restart file. cs A pointer to a MOM_restart_CS object (intent in/out) mom_error_handler::mom_error register_restart_field_2d subroutine subroutine mom_restart::register_restart_field_ptr1d (f_ptr, var_desc, mandatory, CS) register_restart_field_ptr1d f_ptr f_ptr var_desc var_desc mandatory mandatory CS CS Register a 1-d field for restarts, providing the metadata in a structure. f_ptr A pointer to the field to be read or written var_desc A structure with metadata about this variable mandatory If true, the run will abort if this field is not successfully read from the restart file. cs A pointer to a MOM_restart_CS object (intent in/out) mom_error_handler::mom_error register_restart_field_1d subroutine subroutine mom_restart::register_restart_field_ptr0d (f_ptr, var_desc, mandatory, CS) register_restart_field_ptr0d f_ptr f_ptr var_desc var_desc mandatory mandatory CS CS Register a 0-d field for restarts, providing the metadata in a structure. f_ptr A pointer to the field to be read or written var_desc A structure with metadata about this variable mandatory If true, the run will abort if this field is not successfully read from the restart file. cs A pointer to a MOM_restart_CS object (intent in/out) mom_error_handler::mom_error register_restart_field_0d subroutine subroutine mom_restart::register_restart_pair_ptr2d (a_ptr, b_ptr, a_desc, b_desc, mandatory, CS) register_restart_pair_ptr2d a_ptr a_ptr b_ptr b_ptr a_desc a_desc b_desc b_desc mandatory mandatory CS CS Register a pair of rotationally equivalent 2d restart fields. a_ptr First field pointer b_ptr Second field pointer a_desc First field descriptor b_desc Second field descriptor mandatory If true, abort if field is missing cs MOM restart control structure subroutine subroutine mom_restart::register_restart_pair_ptr3d (a_ptr, b_ptr, a_desc, b_desc, mandatory, CS) register_restart_pair_ptr3d a_ptr a_ptr b_ptr b_ptr a_desc a_desc b_desc b_desc mandatory mandatory CS CS Register a pair of rotationally equivalent 3d restart fields. a_ptr First field pointer b_ptr Second field pointer a_desc First field descriptor b_desc Second field descriptor mandatory If true, abort if field is missing cs MOM restart control structure subroutine subroutine mom_restart::register_restart_pair_ptr4d (a_ptr, b_ptr, a_desc, b_desc, mandatory, CS) register_restart_pair_ptr4d a_ptr a_ptr b_ptr b_ptr a_desc a_desc b_desc b_desc mandatory mandatory CS CS Register a pair of rotationally equivalent 2d restart fields. a_ptr First field pointer b_ptr Second field pointer a_desc First field descriptor b_desc Second field descriptor mandatory If true, abort if field is missing cs MOM restart control structure subroutine subroutine mom_restart::register_restart_field_4d (f_ptr, name, mandatory, CS, longname, units, hor_grid, z_grid, t_grid) register_restart_field_4d f_ptr f_ptr name name mandatory mandatory CS CS longname longname units units hor_grid hor_grid z_grid z_grid t_grid t_grid Register a 4-d field for restarts, providing the metadata as individual arguments. f_ptr A pointer to the field to be read or written name variable name to be used in the restart file mandatory If true, the run will abort if this field is not successfully read from the restart file. cs A pointer to a MOM_restart_CS object (intent in/out) longname variable long name units variable units hor_grid variable horizonal staggering, 'h' if absent z_grid variable vertical staggering, 'L' if absent t_grid time description: s, p, or 1, 's' if absent mom_error_handler::mom_error register_restart_field_ptr4d subroutine subroutine mom_restart::register_restart_field_3d (f_ptr, name, mandatory, CS, longname, units, hor_grid, z_grid, t_grid) register_restart_field_3d f_ptr f_ptr name name mandatory mandatory CS CS longname longname units units hor_grid hor_grid z_grid z_grid t_grid t_grid Register a 3-d field for restarts, providing the metadata as individual arguments. f_ptr A pointer to the field to be read or written name variable name to be used in the restart file mandatory If true, the run will abort if this field is not successfully read from the restart file. cs A pointer to a MOM_restart_CS object (intent in/out) longname variable long name units variable units hor_grid variable horizonal staggering, 'h' if absent z_grid variable vertical staggering, 'L' if absent t_grid time description: s, p, or 1, 's' if absent mom_error_handler::mom_error register_restart_field_ptr3d subroutine subroutine mom_restart::register_restart_field_2d (f_ptr, name, mandatory, CS, longname, units, hor_grid, z_grid, t_grid) register_restart_field_2d f_ptr f_ptr name name mandatory mandatory CS CS longname longname units units hor_grid hor_grid z_grid z_grid t_grid t_grid Register a 2-d field for restarts, providing the metadata as individual arguments. f_ptr A pointer to the field to be read or written name variable name to be used in the restart file mandatory If true, the run will abort if this field is not successfully read from the restart file. cs A pointer to a MOM_restart_CS object (intent in/out) longname variable long name units variable units hor_grid variable horizonal staggering, 'h' if absent z_grid variable vertical staggering, '1' if absent t_grid time description: s, p, or 1, 's' if absent mom_error_handler::mom_error register_restart_field_ptr2d subroutine subroutine mom_restart::register_restart_field_1d (f_ptr, name, mandatory, CS, longname, units, hor_grid, z_grid, t_grid) register_restart_field_1d f_ptr f_ptr name name mandatory mandatory CS CS longname longname units units hor_grid hor_grid z_grid z_grid t_grid t_grid Register a 1-d field for restarts, providing the metadata as individual arguments. f_ptr A pointer to the field to be read or written name variable name to be used in the restart file mandatory If true, the run will abort if this field is not successfully read from the restart file. cs A pointer to a MOM_restart_CS object (intent in/out) longname variable long name units variable units hor_grid variable horizonal staggering, '1' if absent z_grid variable vertical staggering, 'L' if absent t_grid time description: s, p, or 1, 's' if absent mom_error_handler::mom_error register_restart_field_ptr1d subroutine subroutine mom_restart::register_restart_field_0d (f_ptr, name, mandatory, CS, longname, units, t_grid) register_restart_field_0d f_ptr f_ptr name name mandatory mandatory CS CS longname longname units units t_grid t_grid Register a 0-d field for restarts, providing the metadata as individual arguments. f_ptr A pointer to the field to be read or written name variable name to be used in the restart file mandatory If true, the run will abort if this field is not successfully read from the restart file. cs A pointer to a MOM_restart_CS object (intent in/out) longname variable long name units variable units t_grid time description: s, p, or 1, 's' if absent mom_error_handler::mom_error register_restart_field_ptr0d logical function logical function mom_restart::query_initialized_name (name, CS) query_initialized_name name name CS CS query_initialized_name determines whether a named field has been successfully read from a restart file yet. name The name of the field that is being queried cs A pointer to a MOM_restart_CS object (intent in) mom_error_handler::is_root_pe mom_error_handler::mom_error restart_error query_initialized_0d_name query_initialized_1d_name query_initialized_2d_name query_initialized_3d_name query_initialized_4d_name logical function logical function mom_restart::query_initialized_0d (f_ptr, CS) query_initialized_0d f_ptr f_ptr CS CS Indicate whether the field pointed to by f_ptr has been initialized from a restart file. f_ptr A pointer to the field that is being queried cs A pointer to a MOM_restart_CS object (intent in) mom_error_handler::mom_error restart_error logical function logical function mom_restart::query_initialized_1d (f_ptr, CS) query_initialized_1d f_ptr f_ptr CS CS Indicate whether the field pointed to by f_ptr has been initialized from a restart file. f_ptr A pointer to the field that is being queried cs A pointer to a MOM_restart_CS object (intent in) mom_error_handler::mom_error restart_error logical function logical function mom_restart::query_initialized_2d (f_ptr, CS) query_initialized_2d f_ptr f_ptr CS CS Indicate whether the field pointed to by f_ptr has been initialized from a restart file. f_ptr A pointer to the field that is being queried cs A pointer to a MOM_restart_CS object (intent in) mom_error_handler::mom_error restart_error logical function logical function mom_restart::query_initialized_3d (f_ptr, CS) query_initialized_3d f_ptr f_ptr CS CS Indicate whether the field pointed to by f_ptr has been initialized from a restart file. f_ptr A pointer to the field that is being queried cs A pointer to a MOM_restart_CS object (intent in) mom_error_handler::mom_error restart_error logical function logical function mom_restart::query_initialized_4d (f_ptr, CS) query_initialized_4d f_ptr f_ptr CS CS Indicate whether the field pointed to by f_ptr has been initialized from a restart file. f_ptr A pointer to the field that is being queried cs A pointer to a MOM_restart_CS object (intent in) mom_error_handler::mom_error restart_error logical function logical function mom_restart::query_initialized_0d_name (f_ptr, name, CS) query_initialized_0d_name f_ptr f_ptr name name CS CS Indicate whether the field pointed to by f_ptr or with the specified variable name has been initialized from a restart file. f_ptr A pointer to the field that is being queried name The name of the field that is being queried cs A pointer to a MOM_restart_CS object (intent in) mom_error_handler::is_root_pe mom_error_handler::mom_error query_initialized_name restart_error logical function logical function mom_restart::query_initialized_1d_name (f_ptr, name, CS) query_initialized_1d_name f_ptr f_ptr name name CS CS Indicate whether the field pointed to by f_ptr or with the specified variable name has been initialized from a restart file. f_ptr A pointer to the field that is being queried name The name of the field that is being queried cs A pointer to a MOM_restart_CS object (intent in) mom_error_handler::is_root_pe mom_error_handler::mom_error query_initialized_name restart_error logical function logical function mom_restart::query_initialized_2d_name (f_ptr, name, CS) query_initialized_2d_name f_ptr f_ptr name name CS CS Indicate whether the field pointed to by f_ptr or with the specified variable name has been initialized from a restart file. f_ptr A pointer to the field that is being queried name The name of the field that is being queried cs A pointer to a MOM_restart_CS object (intent in) mom_error_handler::is_root_pe mom_error_handler::mom_error query_initialized_name restart_error logical function logical function mom_restart::query_initialized_3d_name (f_ptr, name, CS) query_initialized_3d_name f_ptr f_ptr name name CS CS Indicate whether the field pointed to by f_ptr or with the specified variable name has been initialized from a restart file. f_ptr A pointer to the field that is being queried name The name of the field that is being queried cs A pointer to a MOM_restart_CS object (intent in) mom_error_handler::is_root_pe mom_error_handler::mom_error query_initialized_name restart_error logical function logical function mom_restart::query_initialized_4d_name (f_ptr, name, CS) query_initialized_4d_name f_ptr f_ptr name name CS CS Indicate whether the field pointed to by f_ptr or with the specified variable name has been initialized from a restart file. f_ptr A pointer to the field that is being queried name The name of the field that is being queried cs A pointer to a MOM_restart_CS object (intent in) mom_error_handler::is_root_pe mom_error_handler::mom_error query_initialized_name restart_error subroutine, public subroutine, public mom_restart::save_restart (directory, time, G, CS, time_stamped, filename, GV, num_rest_files) save_restart directory directory time time G G CS CS time_stamped time_stamped filename filename GV GV num_rest_files num_rest_files save_restart saves all registered variables to restart files. directory The directory where the restart files are to be written time The current model time g The ocean's grid structure cs The control structure returned by a previous call to restart_init. time_stamped If present and true, add time-stamp to the restart file names. filename A filename that overrides the name in CSrestartfile. gv The ocean's vertical grid structure num_rest_files number of restart files written get_checksum_loop_ranges mom_error_handler::mom_error restart_error mom_surface_forcing_gfdl::forcing_save_restart mom_surface_forcing::forcing_save_restart mom_main ocean_model_mod::ocean_model_restart ocean_model_mod::ocean_model_save_restart subroutine, public subroutine, public mom_restart::restore_state (filename, directory, day, G, CS) restore_state filename filename directory directory day day G G CS CS restore_state reads the model state from previously generated files. All restart variables are read from the first file in the input filename list in which they are found. filename The list of restart file names or a single character 'r' to read automatically named files. directory The directory in which to find restart files day The time of the restarted run g The ocean's grid structure cs The control structure returned by a previous call to restart_init. get_checksum_loop_ranges mom_error_handler::is_root_pe mom_string_functions::lowercase mom_error_handler::mom_error open_restart_units restart_error mom_ice_shelf::initialize_ice_shelf mom_state_initialization::mom_initialize_state mom_surface_forcing_gfdl::surface_forcing_init mom_surface_forcing::surface_forcing_init logical function, public logical function, public mom_restart::restart_files_exist (filename, directory, G, CS) restart_files_exist filename filename directory directory G G CS CS restart_files_exist determines whether any restart files exist. filename The list of restart file names or a single character 'r' to read automatically named files. directory The directory in which to find restart files g The ocean's grid structure cs The control structure returned by a previous call to restart_init. The function result, which indicates whether any of the explicitly or automatically named restart files exist in directory. mom_error_handler::mom_error open_restart_units logical function, public logical function, public mom_restart::determine_is_new_run (filename, directory, G, CS) determine_is_new_run filename filename directory directory G G CS CS determine_is_new_run determines from the value of filename and the existence automatically named restart files in directory whether this would be a new, and as a side effect stores this information in CS. filename The list of restart file names or a single character 'r' to read automatically named files. directory The directory in which to find restart files g The ocean's grid structure cs The control structure returned by a previous call to restart_init. The function result, which indicates whether this is a new run, based on the value of filename and whether restart files exist. is_new_run mom_error_handler::mom_error open_restart_units mom_state_initialization::mom_initialize_state logical function, public logical function, public mom_restart::is_new_run (CS) is_new_run CS CS is_new_run returns whether this is going to be a new run based on the information stored in CS by a previous call to determine_is_new_run. cs The control structure returned by a previous call to restart_init. The function result, which indicates whether this is a new run, based on the value of filename and whether restart files exist. mom_error_handler::mom_error determine_is_new_run mom_dynamics_split_rk2::initialize_dyn_split_rk2 mom::initialize_mom integer function integer function mom_restart::open_restart_units (filename, directory, G, CS, units, file_paths, global_files) open_restart_units filename filename directory directory G G CS CS units units file_paths file_paths global_files global_files open_restart_units determines the number of existing restart files and optionally opens them and returns unit ids, paths and whether the files are global or spatially decomposed. filename The list of restart file names or a single character 'r' to read automatically named files. directory The directory in which to find restart files g The ocean's grid structure cs The control structure returned by a previous call to restart_init. units The mpp units of all opened files. file_paths The full paths to open files. global_files True if a file is global. The number of files (both automatically named restart files and others explicitly in filename) that have been opened. mom_error_handler::is_root_pe mom_error_handler::mom_error determine_is_new_run restart_files_exist restore_state subroutine, public subroutine, public mom_restart::restart_init (param_file, CS, restart_root) restart_init param_file param_file CS CS restart_root restart_root Initialize this module and set up a restart control structure. param_file A structure to parse for run-time parameters cs A pointer to a MOM_restart_CS object that is allocated here restart_root A filename root that overrides the value mom_error_handler::mom_error mom_ice_shelf::initialize_ice_shelf mom::initialize_mom subroutine, public subroutine, public mom_restart::restart_init_end (CS) restart_init_end CS CS Indicate that all variables have now been registered. cs A pointer to a MOM_restart_CS object restart_end mom_surface_forcing_gfdl::surface_forcing_init mom_surface_forcing::surface_forcing_init subroutine, public subroutine, public mom_restart::restart_end (CS) restart_end CS CS Deallocate memory associated with a MOM_restart_CS variable. cs A pointer to a MOM_restart_CS object restart_init_end subroutine subroutine mom_restart::restart_error (CS) restart_error CS CS cs A pointer to a MOM_restart_CS object mom_error_handler::mom_error query_initialized_0d query_initialized_0d_name query_initialized_1d query_initialized_1d_name query_initialized_2d query_initialized_2d_name query_initialized_3d query_initialized_3d_name query_initialized_4d query_initialized_4d_name query_initialized_name restore_state save_restart subroutine subroutine mom_restart::get_checksum_loop_ranges (G, pos, isL, ieL, jsL, jeL) get_checksum_loop_ranges G G pos pos isL isL ieL ieL jsL jsL jeL jeL Return bounds for computing checksums to store in restart files. g The ocean's grid structure pos An integer indicating staggering of variable isl i-start for checksum iel i-end for checksum jsl j-start for checksum jel j-end for checksum restore_state save_restart The MOM6 facility for reading and writing restart files, and querying what has been read.