Detailed Description

A restart registry and the control structure for restarts.

Definition at line 72 of file MOM_restart.F90.

Collaboration diagram for mom_restart::mom_restart_cs:

Public variables and constants
logical	restart
	restart is set to .true. if the run has been started from a full restart file. Otherwise some fields must be initialized approximately. More...

integer	novars = 0
	The number of restart fields that have been registered. More...

integer	num_obsolete_vars = 0
	The number of obsolete restart fields that have been registered. More...

logical	parallel_restartfiles
	If true, each PE writes its own restart file, otherwise they are combined internally. More...

logical	large_file_support
	If true, NetCDF 3.6 or later is being used and large-file-support is enabled. More...

logical	new_run
	If true, the input filenames and restart file existence will result in a new run that is not initialized from restart files. More...

logical	new_run_set = .false.
	If true, new_run has been determined for this restart_CS. More...

logical	checksum_required
	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. More...

character(len=240)	restartfile
	The name or name root for MOM restart files. More...

type(field_restart), dimension(:), pointer	restart_field => NULL()
	An array of descriptions of the registered fields. More...

type(obsolete_restart), dimension(:), pointer	restart_obsolete => NULL()
	An array of obsolete restart fields. More...


type(p0d), dimension(:), pointer	var_ptr0d => NULL()
	Pointers to the fields that have been registered for restarts. More...

type(p1d), dimension(:), pointer	var_ptr1d => NULL()
	Pointers to the fields that have been registered for restarts. More...

type(p2d), dimension(:), pointer	var_ptr2d => NULL()
	Pointers to the fields that have been registered for restarts. More...

type(p3d), dimension(:), pointer	var_ptr3d => NULL()
	Pointers to the fields that have been registered for restarts. More...

type(p4d), dimension(:), pointer	var_ptr4d => NULL()
	Pointers to the fields that have been registered for restarts. More...

integer	max_fields
	The maximum number of restart fields. More...

Variables and constants

◆ checksum_required

logical mom_restart::mom_restart_cs::checksum_required

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.

Definition at line 84 of file MOM_restart.F90.

84 logical :: checksum_required !< If true, require the restart checksums to match and error out otherwise.

◆ large_file_support

logical mom_restart::mom_restart_cs::large_file_support

If true, NetCDF 3.6 or later is being used and large-file-support is enabled.

Definition at line 79 of file MOM_restart.F90.

79 logical :: large_file_support !< If true, NetCDF 3.6 or later is being used

◆ max_fields

integer mom_restart::mom_restart_cs::max_fields

The maximum number of restart fields.

Definition at line 103 of file MOM_restart.F90.

103 integer :: max_fields !< The maximum number of restart fields

◆ new_run

logical mom_restart::mom_restart_cs::new_run

If true, the input filenames and restart file existence will result in a new run that is not initialized from restart files.

Definition at line 81 of file MOM_restart.F90.

81 logical :: new_run !< If true, the input filenames and restart file existence will

◆ new_run_set

logical mom_restart::mom_restart_cs::new_run_set = .false.

If true, new_run has been determined for this restart_CS.

Definition at line 83 of file MOM_restart.F90.

83 logical :: new_run_set = .false. !< If true, new_run has been determined for this restart_CS.

◆ novars

integer mom_restart::mom_restart_cs::novars = 0

The number of restart fields that have been registered.

Definition at line 75 of file MOM_restart.F90.

75 integer :: novars = 0 !< The number of restart fields that have been registered.

◆ num_obsolete_vars

integer mom_restart::mom_restart_cs::num_obsolete_vars = 0

The number of obsolete restart fields that have been registered.

Definition at line 76 of file MOM_restart.F90.

76 integer :: num_obsolete_vars = 0 !< The number of obsolete restart fields that have been registered.

◆ parallel_restartfiles

logical mom_restart::mom_restart_cs::parallel_restartfiles

If true, each PE writes its own restart file, otherwise they are combined internally.

Definition at line 77 of file MOM_restart.F90.

77 logical :: parallel_restartfiles !< If true, each PE writes its own restart file,

◆ restart

logical mom_restart::mom_restart_cs::restart

restart is set to .true. if the run has been started from a full restart file. Otherwise some fields must be initialized approximately.

Definition at line 73 of file MOM_restart.F90.

73 logical :: restart !< restart is set to .true. if the run has been started from a full restart

◆ restart_field

type(field_restart), dimension(:), pointer mom_restart::mom_restart_cs::restart_field => NULL()

An array of descriptions of the registered fields.

Definition at line 91 of file MOM_restart.F90.

91 type(field_restart), pointer :: restart_field(:) => null()

◆ restart_obsolete

type(obsolete_restart), dimension(:), pointer mom_restart::mom_restart_cs::restart_obsolete => NULL()

An array of obsolete restart fields.

Definition at line 94 of file MOM_restart.F90.

94 type(obsolete_restart), pointer :: restart_obsolete(:) => null()

◆ restartfile

character(len=240) mom_restart::mom_restart_cs::restartfile

The name or name root for MOM restart files.

Definition at line 88 of file MOM_restart.F90.

88 character(len=240) :: restartfile !< The name or name root for MOM restart files.