mom_restart::register_restart_pair Interface Reference

Detailed Description

Register a pair of restart fieilds whose rotations map onto each other.

Definition at line 120 of file MOM_restart.F90.

Private functions
subroutine	register_restart_pair_ptr2d (a_ptr, b_ptr, a_desc, b_desc, mandatory, CS)
	Register a pair of rotationally equivalent 2d restart fields. More...
subroutine	register_restart_pair_ptr3d (a_ptr, b_ptr, a_desc, b_desc, mandatory, CS)
	Register a pair of rotationally equivalent 3d restart fields. More...
subroutine	register_restart_pair_ptr4d (a_ptr, b_ptr, a_desc, b_desc, mandatory, CS)
	Register a pair of rotationally equivalent 2d restart fields. More...

Detailed Description

Register a pair of restart fieilds whose rotations map onto each other.

Definition at line 120 of file MOM_restart.F90.

Functions and subroutines

register_restart_pair_ptr2d()

subroutine mom_restart::register_restart_pair::register_restart_pair_ptr2d ( real, dimension(:,:), intent(in), target  a_ptr, real, dimension(:,:), intent(in), target  b_ptr, type(vardesc), intent(in)  a_desc, type(vardesc), intent(in)  b_desc, logical, intent(in)  mandatory, type(mom_restart_cs), pointer  CS  )

private

Register a pair of rotationally equivalent 2d restart fields.

Parameters

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

Definition at line 305 of file MOM_restart.F90.

  real, dimension(:,:), target, intent(in) :: a_ptr   !< First field pointer
  real, dimension(:,:), target, intent(in) :: b_ptr   !< Second field pointer
  type(vardesc), intent(in) :: a_desc   !< First field descriptor
  type(vardesc), intent(in) :: b_desc   !< Second field descriptor
  logical, intent(in) :: mandatory      !< If true, abort if field is missing
  type(MOM_restart_CS), pointer :: CS   !< MOM restart control structure
 
  if (modulo(cs%turns, 2) /= 0) then
    call register_restart_field(b_ptr, a_desc, mandatory, cs)
    call register_restart_field(a_ptr, b_desc, mandatory, cs)
  else
    call register_restart_field(a_ptr, a_desc, mandatory, cs)
    call register_restart_field(b_ptr, b_desc, mandatory, cs)
  endif

register_restart_pair_ptr3d()

subroutine mom_restart::register_restart_pair::register_restart_pair_ptr3d ( real, dimension(:,:,:), intent(in), target  a_ptr, real, dimension(:,:,:), intent(in), target  b_ptr, type(vardesc), intent(in)  a_desc, type(vardesc), intent(in)  b_desc, logical, intent(in)  mandatory, type(mom_restart_cs), pointer  CS  )

private

Register a pair of rotationally equivalent 3d restart fields.

Parameters

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

Definition at line 325 of file MOM_restart.F90.

  real, dimension(:,:,:), target, intent(in) :: a_ptr   !< First field pointer
  real, dimension(:,:,:), target, intent(in) :: b_ptr   !< Second field pointer
  type(vardesc), intent(in) :: a_desc   !< First field descriptor
  type(vardesc), intent(in) :: b_desc   !< Second field descriptor
  logical, intent(in) :: mandatory      !< If true, abort if field is missing
  type(MOM_restart_CS), pointer :: CS   !< MOM restart control structure
 
  if (modulo(cs%turns, 2) /= 0) then
    call register_restart_field(b_ptr, a_desc, mandatory, cs)
    call register_restart_field(a_ptr, b_desc, mandatory, cs)
  else
    call register_restart_field(a_ptr, a_desc, mandatory, cs)
    call register_restart_field(b_ptr, b_desc, mandatory, cs)
  endif

register_restart_pair_ptr4d()

subroutine mom_restart::register_restart_pair::register_restart_pair_ptr4d ( real, dimension(:,:,:,:), intent(in), target  a_ptr, real, dimension(:,:,:,:), intent(in), target  b_ptr, type(vardesc), intent(in)  a_desc, type(vardesc), intent(in)  b_desc, logical, intent(in)  mandatory, type(mom_restart_cs), pointer  CS  )

private

Register a pair of rotationally equivalent 2d restart fields.

Parameters

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

Definition at line 345 of file MOM_restart.F90.

  real, dimension(:,:,:,:), target, intent(in) :: a_ptr !< First field pointer
  real, dimension(:,:,:,:), target, intent(in) :: b_ptr !< Second field pointer
  type(vardesc), intent(in) :: a_desc   !< First field descriptor
  type(vardesc), intent(in) :: b_desc   !< Second field descriptor
  logical, intent(in) :: mandatory      !< If true, abort if field is missing
  type(MOM_restart_CS), pointer :: CS   !< MOM restart control structure
 
  if (modulo(cs%turns, 2) /= 0) then
    call register_restart_field(b_ptr, a_desc, mandatory, cs)
    call register_restart_field(a_ptr, b_desc, mandatory, cs)
  else
    call register_restart_field(a_ptr, a_desc, mandatory, cs)
    call register_restart_field(b_ptr, b_desc, mandatory, cs)
  endif

---

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

• /home/cermak/src/MOM6.devrob/src/framework/MOM_restart.F90