mom_restart::register_restart_field Interface Reference

Detailed Description

Definition at line 135 of file MOM_restart.F90.

Private functions
subroutine	register_restart_field_ptr4d (f_ptr, var_desc, mandatory, CS)
subroutine	register_restart_field_ptr3d (f_ptr, var_desc, mandatory, CS)
subroutine	register_restart_field_ptr2d (f_ptr, var_desc, mandatory, CS)
subroutine	register_restart_field_ptr1d (f_ptr, var_desc, mandatory, CS)
subroutine	register_restart_field_ptr0d (f_ptr, var_desc, mandatory, CS)

Functions and subroutines

register_restart_field_ptr0d()

subroutine mom_restart::register_restart_field::register_restart_field_ptr0d ( real, target  f_ptr, type(vardesc), intent(in)  var_desc, logical, intent(in)  mandatory, type(mom_restart_cs), pointer  CS  )

private

Definition at line 307 of file MOM_restart.F90.

  real, target :: f_ptr
  type(vardesc), intent(in) :: var_desc
  logical, intent(in)       :: mandatory
  type(mom_restart_cs),  pointer :: cs
!  Set up a field that will be written to and read from restart
!  files.
!
! Arguments: f_ptr - A pointer to the field to be read or written.
!  (in)      var_desc - The descriptive structure for the field.
!  (in)      mandatory - If .true. the run will abort if this field is not
!                        successfully read from the restart file.  If .false.,
!                        alternate techniques are provided to initialize this
!                        field if it is cannot be read from the file.
!  (in/out)  CS - The control structure returned by a previous call to
!                 restart_init.
  if (.not.associated(cs)) call mom_error(fatal, "MOM_restart " // &
      "register_restart_field: Module must be initialized before it is used.")

  cs%novars = cs%novars+1
  if (cs%novars > cs%max_fields) return ! This is an error that will be reported
                                     ! once the total number of fields is known.

  cs%restart_field(cs%novars)%vars = var_desc
  cs%restart_field(cs%novars)%mand_var = mandatory
  cs%restart_field(cs%novars)%initialized = .false.
  call query_vardesc(cs%restart_field(cs%novars)%vars, &
                     name=cs%restart_field(cs%novars)%var_name, &
                     caller="register_restart_field_ptr0d")

  cs%var_ptr0d(cs%novars)%p => f_ptr
  cs%var_ptr4d(cs%novars)%p => null()
  cs%var_ptr3d(cs%novars)%p => null()
  cs%var_ptr2d(cs%novars)%p => null()
  cs%var_ptr1d(cs%novars)%p => null()

register_restart_field_ptr1d()

subroutine mom_restart::register_restart_field::register_restart_field_ptr1d ( real, dimension(:), target  f_ptr, type(vardesc), intent(in)  var_desc, logical, intent(in)  mandatory, type(mom_restart_cs), pointer  CS  )

private

Definition at line 269 of file MOM_restart.F90.

  real, dimension(:), target :: f_ptr
  type(vardesc), intent(in) :: var_desc
  logical, intent(in)       :: mandatory
  type(mom_restart_cs),  pointer :: cs
!  Set up a field that will be written to and read from restart
!  files.
!
! Arguments: f_ptr - A pointer to the field to be read or written.
!  (in)      var_desc - The descriptive structure for the field.
!  (in)      mandatory - If .true. the run will abort if this field is not
!                        successfully read from the restart file.  If .false.,
!                        alternate techniques are provided to initialize this
!                        field if it is cannot be read from the file.
!  (in/out)  CS - The control structure returned by a previous call to
!                 restart_init.
  if (.not.associated(cs)) call mom_error(fatal, "MOM_restart " // &
      "register_restart_field: Module must be initialized before it is used.")

  cs%novars = cs%novars+1
  if (cs%novars > cs%max_fields) return ! This is an error that will be reported
                                     ! once the total number of fields is known.

  cs%restart_field(cs%novars)%vars = var_desc
  cs%restart_field(cs%novars)%mand_var = mandatory
  cs%restart_field(cs%novars)%initialized = .false.
  call query_vardesc(cs%restart_field(cs%novars)%vars, &
                     name=cs%restart_field(cs%novars)%var_name, &
                     caller="register_restart_field_ptr1d")

  cs%var_ptr1d(cs%novars)%p => f_ptr
  cs%var_ptr4d(cs%novars)%p => null()
  cs%var_ptr3d(cs%novars)%p => null()
  cs%var_ptr2d(cs%novars)%p => null()
  cs%var_ptr0d(cs%novars)%p => null()

register_restart_field_ptr2d()

subroutine mom_restart::register_restart_field::register_restart_field_ptr2d ( real, dimension(:,:), target  f_ptr, type(vardesc), intent(in)  var_desc, logical, intent(in)  mandatory, type(mom_restart_cs), pointer  CS  )

private

Definition at line 231 of file MOM_restart.F90.

  real, dimension(:,:), target :: f_ptr
  type(vardesc), intent(in) :: var_desc
  logical, intent(in)       :: mandatory
  type(mom_restart_cs),  pointer :: cs
!  Set up a field that will be written to and read from restart
!  files.
!
! Arguments: f_ptr - A pointer to the field to be read or written.
!  (in)      var_desc - The descriptive structure for the field.
!  (in)      mandatory - If .true. the run will abort if this field is not
!                        successfully read from the restart file.  If .false.,
!                        alternate techniques are provided to initialize this
!                        field if it is cannot be read from the file.
!  (in/out)  CS - The control structure returned by a previous call to
!                 restart_init.
  if (.not.associated(cs)) call mom_error(fatal, "MOM_restart " // &
      "register_restart_field: Module must be initialized before it is used.")

  cs%novars = cs%novars+1
  if (cs%novars > cs%max_fields) return ! This is an error that will be reported
                                     ! once the total number of fields is known.

  cs%restart_field(cs%novars)%vars = var_desc
  cs%restart_field(cs%novars)%mand_var = mandatory
  cs%restart_field(cs%novars)%initialized = .false.
  call query_vardesc(cs%restart_field(cs%novars)%vars, &
                     name=cs%restart_field(cs%novars)%var_name, &
                     caller="register_restart_field_ptr2d")

  cs%var_ptr2d(cs%novars)%p => f_ptr
  cs%var_ptr4d(cs%novars)%p => null()
  cs%var_ptr3d(cs%novars)%p => null()
  cs%var_ptr1d(cs%novars)%p => null()
  cs%var_ptr0d(cs%novars)%p => null()

register_restart_field_ptr3d()

subroutine mom_restart::register_restart_field::register_restart_field_ptr3d ( real, dimension(:,:,:), target  f_ptr, type(vardesc), intent(in)  var_desc, logical, intent(in)  mandatory, type(mom_restart_cs), pointer  CS  )

private

Definition at line 155 of file MOM_restart.F90.

  real, dimension(:,:,:), target :: f_ptr
  type(vardesc),      intent(in) :: var_desc
  logical,            intent(in) :: mandatory
  type(mom_restart_cs),  pointer :: cs
!  Set up a field that will be written to and read from restart
!  files.
!
! Arguments: f_ptr - A pointer to the field to be read or written.
!  (in)      var_desc - The descriptive structure for the field.
!  (in)      mandatory - If .true. the run will abort if this field is not
!                        successfully read from the restart file.  If .false.,
!                        alternate techniques are provided to initialize this
!                        field if it is cannot be read from the file.
!  (in/out)  CS - The control structure returned by a previous call to
!                 restart_init.
  if (.not.associated(cs)) call mom_error(fatal, "MOM_restart " // &
      "register_restart_field: Module must be initialized before it is used.")

  cs%novars = cs%novars+1
  if (cs%novars > cs%max_fields) return ! This is an error that will be reported
                                     ! once the total number of fields is known.

  cs%restart_field(cs%novars)%vars = var_desc
  cs%restart_field(cs%novars)%mand_var = mandatory
  cs%restart_field(cs%novars)%initialized = .false.
  call query_vardesc(cs%restart_field(cs%novars)%vars, &
                     name=cs%restart_field(cs%novars)%var_name, &
                     caller="register_restart_field_ptr3d")

  cs%var_ptr3d(cs%novars)%p => f_ptr
  cs%var_ptr4d(cs%novars)%p => null()
  cs%var_ptr2d(cs%novars)%p => null()
  cs%var_ptr1d(cs%novars)%p => null()
  cs%var_ptr0d(cs%novars)%p => null()

register_restart_field_ptr4d()

subroutine mom_restart::register_restart_field::register_restart_field_ptr4d ( real, dimension(:,:,:,:), target  f_ptr, type(vardesc), intent(in)  var_desc, logical, intent(in)  mandatory, type(mom_restart_cs), pointer  CS  )

private

Definition at line 193 of file MOM_restart.F90.

  real, dimension(:,:,:,:), target :: f_ptr
  type(vardesc),      intent(in) :: var_desc
  logical,            intent(in) :: mandatory
  type(mom_restart_cs),  pointer :: cs
!  Set up a field that will be written to and read from restart
!  files.
!
! Arguments: f_ptr - A pointer to the field to be read or written.
!  (in)      var_desc - The descriptive structure for the field.
!  (in)      mandatory - If .true. the run will abort if this field is not
!                        successfully read from the restart file.  If .false.,
!                        alternate techniques are provided to initialize this
!                        field if it is cannot be read from the file.
!  (in/out)  CS - The control structure returned by a previous call to
!                 restart_init.
  if (.not.associated(cs)) call mom_error(fatal, "MOM_restart " // &
      "register_restart_field: Module must be initialized before it is used.")

  cs%novars = cs%novars+1
  if (cs%novars > cs%max_fields) return ! This is an error that will be reported
                                     ! once the total number of fields is known.

  cs%restart_field(cs%novars)%vars = var_desc
  cs%restart_field(cs%novars)%mand_var = mandatory
  cs%restart_field(cs%novars)%initialized = .false.
  call query_vardesc(cs%restart_field(cs%novars)%vars, &
                     name=cs%restart_field(cs%novars)%var_name, &
                     caller="register_restart_field_ptr4d")

  cs%var_ptr4d(cs%novars)%p => f_ptr
  cs%var_ptr3d(cs%novars)%p => null()
  cs%var_ptr2d(cs%novars)%p => null()
  cs%var_ptr1d(cs%novars)%p => null()
  cs%var_ptr0d(cs%novars)%p => null()

---

The documentation for this interface was generated from the following file:

• /home/adcroft/GitHub/workspace/Gaea-stats-MOM6-examples/MOM6-examples/src/MOM6/src/framework/MOM_restart.F90