mom_restart::register_restart_field subroutine subroutine mom_restart::register_restart_field::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) subroutine subroutine mom_restart::register_restart_field::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 subroutine subroutine mom_restart::register_restart_field::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) subroutine subroutine mom_restart::register_restart_field::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 subroutine subroutine mom_restart::register_restart_field::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) subroutine subroutine mom_restart::register_restart_field::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 subroutine subroutine mom_restart::register_restart_field::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) subroutine subroutine mom_restart::register_restart_field::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 subroutine subroutine mom_restart::register_restart_field::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) subroutine subroutine mom_restart::register_restart_field::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 Register fields for restarts. mom_restart::register_restart_fieldregister_restart_field_0d mom_restart::register_restart_fieldregister_restart_field_1d mom_restart::register_restart_fieldregister_restart_field_2d mom_restart::register_restart_fieldregister_restart_field_3d mom_restart::register_restart_fieldregister_restart_field_4d mom_restart::register_restart_fieldregister_restart_field_ptr0d mom_restart::register_restart_fieldregister_restart_field_ptr1d mom_restart::register_restart_fieldregister_restart_field_ptr2d mom_restart::register_restart_fieldregister_restart_field_ptr3d mom_restart::register_restart_fieldregister_restart_field_ptr4d