mom_restart module reference¶

The MOM6 facility for reading and writing restart files, and querying what has been read.

Data Types¶

`field_restart`	A structure with information about a single restart field.
`mom_restart_cs`	A restart registry and the control structure for restarts.
`obsolete_restart`	A structure to store information about restart fields that are no longer used.
`p0d`	A type for making arrays of pointers to scalars.
`p1d`	A type for making arrays of pointers to 1-d arrays.
`p2d`	A type for making arrays of pointers to 2-d arrays.
`p3d`	A type for making arrays of pointers to 3-d arrays.
`p4d`	A type for making arrays of pointers to 4-d arrays.

Functions/Subroutines¶

`register_restart_field_as_obsolete()`
`register_restart_field_ptr3d()`	Register a 3-d field for restarts, providing the metadata in a structure.
`register_restart_field_ptr4d()`	Register a 4-d field for restarts, providing the metadata in a structure.
`register_restart_field_ptr2d()`	Register a 2-d field for restarts, providing the metadata in a structure.
`register_restart_field_ptr1d()`	Register a 1-d field for restarts, providing the metadata in a structure.
`register_restart_field_ptr0d()`	Register a 0-d field for restarts, providing the metadata in a structure.
`register_restart_pair_ptr2d()`	Register a pair of rotationally equivalent 2d restart fields.
`register_restart_pair_ptr3d()`	Register a pair of rotationally equivalent 3d restart fields.
`register_restart_pair_ptr4d()`	Register a pair of rotationally equivalent 2d restart fields.
`register_restart_field_4d()`	Register a 4-d field for restarts, providing the metadata as individual arguments.
`register_restart_field_3d()`	Register a 3-d field for restarts, providing the metadata as individual arguments.
`register_restart_field_2d()`	Register a 2-d field for restarts, providing the metadata as individual arguments.
`register_restart_field_1d()`	Register a 1-d field for restarts, providing the metadata as individual arguments.
`register_restart_field_0d()`	Register a 0-d field for restarts, providing the metadata as individual arguments.
`query_initialized_name()`	query_initialized_name determines whether a named field has been successfully read from a restart file yet.
`query_initialized_0d()`	Indicate whether the field pointed to by f_ptr has been initialized from a restart file.
`query_initialized_1d()`	Indicate whether the field pointed to by f_ptr has been initialized from a restart file.
`query_initialized_2d()`	Indicate whether the field pointed to by f_ptr has been initialized from a restart file.
`query_initialized_3d()`	Indicate whether the field pointed to by f_ptr has been initialized from a restart file.
`query_initialized_4d()`	Indicate whether the field pointed to by f_ptr has been initialized from a restart file.
`query_initialized_0d_name()`	Indicate whether the field pointed to by f_ptr or with the specified variable name has been initialized from a restart file.
`query_initialized_1d_name()`	Indicate whether the field pointed to by f_ptr or with the specified variable name has been initialized from a restart file.
`query_initialized_2d_name()`	Indicate whether the field pointed to by f_ptr or with the specified variable name has been initialized from a restart file.
`query_initialized_3d_name()`	Indicate whether the field pointed to by f_ptr or with the specified variable name has been initialized from a restart file.
`query_initialized_4d_name()`	Indicate whether the field pointed to by f_ptr or with the specified variable name has been initialized from a restart file.
`save_restart()`	save_restart saves all registered variables to restart files.
`restore_state()`	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.
`restart_files_exist()`	restart_files_exist determines whether any restart files exist.
`determine_is_new_run()`	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.
`is_new_run()`	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.
`open_restart_units()`	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.
`restart_init()`	Initialize this module and set up a restart control structure.
`restart_init_end()`	Indicate that all variables have now been registered.
`restart_end()`	Deallocate memory associated with a MOM_restart_CS variable.
`restart_error()`
`get_checksum_loop_ranges()`	Return bounds for computing checksums to store in restart files.

Detailed Description¶

The MOM6 facility for reading and writing restart files, and querying what has been read.

Type Documentation¶

type mom_restart/field_restart¶

A structure with information about a single restart field.

Type fields

% vars [type(vardesc),private] :: Description of a field that is to be read from or written to the restart file.
% mand_var [logical,private] :: If .true. the run will abort if this field is not successfully read from the restart file.
% initialized [logical,private] :: .true. if this field has been read from the restart file.
% var_name [character (len=32),private] :: A name by which a variable may be queried.

type mom_restart/mom_restart_cs¶

A restart registry and the control structure for restarts.

Type fields

% var_ptr0d [type( p0d )(:),pointer] :: Pointers to the fields that have been registered for restarts.
% var_ptr1d [type( p1d )(:),pointer] :: Pointers to the fields that have been registered for restarts.
% var_ptr2d [type( p2d )(:),pointer] :: Pointers to the fields that have been registered for restarts.
% var_ptr3d [type( p3d )(:),pointer] :: Pointers to the fields that have been registered for restarts.
% var_ptr4d [type( p4d )(:),pointer] :: Pointers to the fields that have been registered for restarts.
% restart [logical] :: restart is set to .true. if the run has been started from a full restart file. Otherwise some fields must be initialized approximately.
% novars [integer] :: The number of restart fields that have been registered.
% num_obsolete_vars [integer] :: The number of obsolete restart fields that have been registered.
% parallel_restartfiles [logical] :: If true, each PE writes its own restart file, otherwise they are combined internally.
% large_file_support [logical] :: If true, NetCDF 3.6 or later is being used and large-file-support is enabled.
% new_run [logical] :: If true, the input filenames and restart file existence will result in a new run that is not initialized from restart files.
% new_run_set [logical] :: If true, new_run has been determined for this restart_CS.
% checksum_required [logical] :: If true, require the restart checksums to match and error out otherwise. Users may want to avoid this comparison if for example the restarts are made from a run with a different mask_table than the current run, in which case the checksums will not match and cause crash.
% restartfile [character (len=240)] :: The name or name root for MOM restart files.
% turns [integer] :: Number of quarter turns from input to model domain.
% restart_field [type( field_restart )(:),pointer] :: An array of descriptions of the registered fields.
% restart_obsolete [type( obsolete_restart )(:),pointer] :: An array of obsolete restart fields.
% max_fields [integer] :: The maximum number of restart fields.

type mom_restart/obsolete_restart¶

A structure to store information about restart fields that are no longer used.

Type fields

% field_name [character (len=32),private] :: Name of restart field that is no longer in use.
% replacement_name [character (len=32),private] :: Name of replacement restart field, if applicable.

type mom_restart/p0d¶

A type for making arrays of pointers to scalars.

Type fields

% p [real,pointer, private] :: A pointer to a scalar.

type mom_restart/p1d¶

A type for making arrays of pointers to 1-d arrays.

Type fields

% p [real(:),pointer, private] :: A pointer to a 1d array.

type mom_restart/p2d¶

A type for making arrays of pointers to 2-d arrays.

Type fields

% p [real(:,:),pointer, private] :: A pointer to a 2d array.

type mom_restart/p3d¶

A type for making arrays of pointers to 3-d arrays.

Type fields

% p [real(:,:,:),pointer, private] :: A pointer to a 3d array.

type mom_restart/p4d¶

A type for making arrays of pointers to 4-d arrays.

Type fields

% p [real(:,:,:,:),pointer, private] :: A pointer to a 4d array.

Function/Subroutine Documentation¶

subroutine mom_restart/register_restart_field_as_obsolete(field_name, replacement_name, CS)¶

Parameters

field_name :: [in] Name of restart field that is no longer in use
replacement_name :: [in] Name of replacement restart field, if applicable
cs :: A pointer to a MOM_restart_CS object (intent in/out)

Called from

mom_set_visc::set_visc_init

subroutine mom_restart/register_restart_field_ptr3d(f_ptr, var_desc, mandatory, CS)¶

Register a 3-d field for restarts, providing the metadata in a structure.

Parameters

f_ptr :: [in] A pointer to the field to be read or written
var_desc :: [in] A structure with metadata about this variable
mandatory :: [in] 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)

Call to

mom_error_handler::mom_error

Called from

register_restart_field_3d

subroutine mom_restart/register_restart_field_ptr4d(f_ptr, var_desc, mandatory, CS)¶

Register a 4-d field for restarts, providing the metadata in a structure.

Parameters

f_ptr :: [in] A pointer to the field to be read or written
var_desc :: [in] A structure with metadata about this variable
mandatory :: [in] 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)

Call to

mom_error_handler::mom_error

Called from

register_restart_field_4d

subroutine mom_restart/register_restart_field_ptr2d(f_ptr, var_desc, mandatory, CS)¶

Register a 2-d field for restarts, providing the metadata in a structure.

Parameters

f_ptr :: [in] A pointer to the field to be read or written
var_desc :: [in] A structure with metadata about this variable
mandatory :: [in] 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)

Call to

mom_error_handler::mom_error

Called from

register_restart_field_2d

subroutine mom_restart/register_restart_field_ptr1d(f_ptr, var_desc, mandatory, CS)¶

Register a 1-d field for restarts, providing the metadata in a structure.

Parameters

f_ptr :: [in] A pointer to the field to be read or written
var_desc :: [in] A structure with metadata about this variable
mandatory :: [in] 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)

Call to

mom_error_handler::mom_error

Called from

register_restart_field_1d

subroutine mom_restart/register_restart_field_ptr0d(f_ptr, var_desc, mandatory, CS)¶

Register a 0-d field for restarts, providing the metadata in a structure.

Parameters

f_ptr :: [in] A pointer to the field to be read or written
var_desc :: [in] A structure with metadata about this variable
mandatory :: [in] 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)

Call to

mom_error_handler::mom_error

Called from

register_restart_field_0d

subroutine mom_restart/register_restart_pair_ptr2d(a_ptr, b_ptr, a_desc, b_desc, mandatory, CS)¶

Register a pair of rotationally equivalent 2d restart fields.

Parameters

a_ptr :: [in] First field pointer
b_ptr :: [in] Second field pointer
a_desc :: [in] First field descriptor
b_desc :: [in] Second field descriptor
mandatory :: [in] If true, abort if field is missing
cs :: MOM restart control structure

subroutine mom_restart/register_restart_pair_ptr3d(a_ptr, b_ptr, a_desc, b_desc, mandatory, CS)¶

Register a pair of rotationally equivalent 3d restart fields.

Parameters

a_ptr :: [in] First field pointer
b_ptr :: [in] Second field pointer
a_desc :: [in] First field descriptor
b_desc :: [in] Second field descriptor
mandatory :: [in] If true, abort if field is missing
cs :: MOM restart control structure

subroutine mom_restart/register_restart_pair_ptr4d(a_ptr, b_ptr, a_desc, b_desc, mandatory, CS)¶

Register a pair of rotationally equivalent 2d restart fields.

Parameters

a_ptr :: [in] First field pointer
b_ptr :: [in] Second field pointer
a_desc :: [in] First field descriptor
b_desc :: [in] Second field descriptor
mandatory :: [in] If true, abort if field is missing
cs :: MOM restart control structure

subroutine mom_restart/register_restart_field_4d(f_ptr, name, mandatory, CS, longname, units, hor_grid, z_grid, t_grid)¶

Register a 4-d field for restarts, providing the metadata as individual arguments.

Parameters

f_ptr :: [in] A pointer to the field to be read or written
name :: [in] variable name to be used in the restart file
mandatory :: [in] 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 :: [in] variable long name
units :: [in] variable units
hor_grid :: [in] variable horizonal staggering, ‘h’ if absent
z_grid :: [in] variable vertical staggering, ‘L’ if absent
t_grid :: [in] time description: s, p, or 1, ‘s’ if absent

Call to

mom_error_handler::mom_error register_restart_field_ptr4d

subroutine mom_restart/register_restart_field_3d(f_ptr, name, mandatory, CS, longname, units, hor_grid, z_grid, t_grid)¶

Register a 3-d field for restarts, providing the metadata as individual arguments.

Parameters

f_ptr :: [in] A pointer to the field to be read or written
name :: [in] variable name to be used in the restart file
mandatory :: [in] 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 :: [in] variable long name
units :: [in] variable units
hor_grid :: [in] variable horizonal staggering, ‘h’ if absent
z_grid :: [in] variable vertical staggering, ‘L’ if absent
t_grid :: [in] time description: s, p, or 1, ‘s’ if absent

Call to

mom_error_handler::mom_error register_restart_field_ptr3d

subroutine mom_restart/register_restart_field_2d(f_ptr, name, mandatory, CS, longname, units, hor_grid, z_grid, t_grid)¶

Register a 2-d field for restarts, providing the metadata as individual arguments.

Parameters

f_ptr :: [in] A pointer to the field to be read or written
name :: [in] variable name to be used in the restart file
mandatory :: [in] 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 :: [in] variable long name
units :: [in] variable units
hor_grid :: [in] variable horizonal staggering, ‘h’ if absent
z_grid :: [in] variable vertical staggering, ‘1’ if absent
t_grid :: [in] time description: s, p, or 1, ‘s’ if absent

Call to

mom_error_handler::mom_error register_restart_field_ptr2d

subroutine mom_restart/register_restart_field_1d(f_ptr, name, mandatory, CS, longname, units, hor_grid, z_grid, t_grid)¶

Register a 1-d field for restarts, providing the metadata as individual arguments.

Parameters

f_ptr :: [in] A pointer to the field to be read or written
name :: [in] variable name to be used in the restart file
mandatory :: [in] 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 :: [in] variable long name
units :: [in] variable units
hor_grid :: [in] variable horizonal staggering, ‘1’ if absent
z_grid :: [in] variable vertical staggering, ‘L’ if absent
t_grid :: [in] time description: s, p, or 1, ‘s’ if absent

Call to

mom_error_handler::mom_error register_restart_field_ptr1d

subroutine mom_restart/register_restart_field_0d(f_ptr, name, mandatory, CS, longname, units, t_grid)¶

Register a 0-d field for restarts, providing the metadata as individual arguments.

Parameters

f_ptr :: [in] A pointer to the field to be read or written
name :: [in] variable name to be used in the restart file
mandatory :: [in] 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 :: [in] variable long name
units :: [in] variable units
t_grid :: [in] time description: s, p, or 1, ‘s’ if absent

Call to

mom_error_handler::mom_error register_restart_field_ptr0d

function mom_restart/query_initialized_name(name, CS) [logical]¶

query_initialized_name determines whether a named field has been successfully read from a restart file yet.

Parameters

name :: [in] The name of the field that is being queried
cs :: A pointer to a MOM_restart_CS object (intent in)

Call to

mom_error_handler::is_root_pe mom_error_handler::mom_error restart_error

Called from

query_initialized_0d_name query_initialized_1d_name query_initialized_2d_name query_initialized_3d_name query_initialized_4d_name

function mom_restart/query_initialized_0d(f_ptr, CS) [logical]¶

Indicate whether the field pointed to by f_ptr has been initialized from a restart file.

Parameters

f_ptr :: [in] A pointer to the field that is being queried
cs :: A pointer to a MOM_restart_CS object (intent in)

Call to

mom_error_handler::mom_error restart_error

function mom_restart/query_initialized_1d(f_ptr, CS) [logical]¶

Indicate whether the field pointed to by f_ptr has been initialized from a restart file.

Parameters

f_ptr :: [in] A pointer to the field that is being queried
cs :: A pointer to a MOM_restart_CS object (intent in)

Call to

mom_error_handler::mom_error restart_error

function mom_restart/query_initialized_2d(f_ptr, CS) [logical]¶

Indicate whether the field pointed to by f_ptr has been initialized from a restart file.

Parameters

f_ptr :: [in] A pointer to the field that is being queried
cs :: A pointer to a MOM_restart_CS object (intent in)

Call to

mom_error_handler::mom_error restart_error

function mom_restart/query_initialized_3d(f_ptr, CS) [logical]¶

Indicate whether the field pointed to by f_ptr has been initialized from a restart file.

Parameters

f_ptr :: [in] A pointer to the field that is being queried
cs :: A pointer to a MOM_restart_CS object (intent in)

Call to

mom_error_handler::mom_error restart_error

function mom_restart/query_initialized_4d(f_ptr, CS) [logical]¶

Indicate whether the field pointed to by f_ptr has been initialized from a restart file.

Parameters

f_ptr :: [in] A pointer to the field that is being queried
cs :: A pointer to a MOM_restart_CS object (intent in)

Call to

mom_error_handler::mom_error restart_error

function mom_restart/query_initialized_0d_name(f_ptr, name, CS) [logical]¶