#include "AUTODIFF_OPTIONS.h"

c     ==================================================================
c
c     active_file.F: Routines to handle the I/O of the active file for
c                    the adjoint calculations. All files are direct
c                    access files.
c
c     Routines
c
c    o  active_read_xy         - Read  an active 2D variable from file.
c    o  active_read_xyz        - Read  an active 3D variable from file.
c    o  active_read_xz         - Read  an active 2D xz-slice from file.
c    o  active_read_yz         - Read  an active 2D yz-slice from file.
c
c    o  active_write_xy        - Write an active 2D variable to a file.
c    o  active_write_xyz       - Write an active 3D variable to a file.
c    o  active_write_xz        - Write an active 2D xz-slice to a file.
c    o  active_write_yz        - Write an active 2D yz-slice to a file.
c
c    o  active_read_tile_xy    - Read  an active 2D variable from file.
c    o  active_read_tile_xyz   - Read  an active 3D variable from file.
c
c    o  active_write_tile_xy   - Write an active 2D variable to a file.
c    o  active_write_tile_xyz  - Write an active 3D variable to a file.
c
c
c        changed: Christian Eckert eckert@mit.edu 24-Apr-2000
c                 - Added routines that do active writes on tiles
c                   instead of a whole thread.
c        changed: heimbach@mit.edu 05-Mar-2001
c                 - added active file handling of xz-/yz-arrays
c
c     ==================================================================


CBOP
C     !ROUTINE: active_read_xy
C     !INTERFACE:
      subroutine ACTIVE_READ_XY(
     I                           active_var_file,
     O                           active_var,
     I                           irec,
     I                           doglobalread,
     I                           lAdInit,
     I                           myOptimIter,
     I                           mythid
     I                         , dummy
     &                         )

C     !DESCRIPTION: \bv
c     ==================================================================
c     SUBROUTINE active_read_xy
c     ==================================================================
c     o Read an active 2D (XY) variable from file.
c     started: Christian Eckert eckert@mit.edu 30-Jun-1999
c     ==================================================================
c     SUBROUTINE active_read_xy
c     ==================================================================
C     \ev

C     !USES:
      implicit none

c     == global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"

C     !INPUT/OUTPUT PARAMETERS:
c     == routine arguments ==
c     active_var_file: filename
c     active_var:      array
c     irec:            record number
c     myOptimIter:     number of optimization iteration (default: 0)
c     mythid:          thread number for this instance
c     doglobalread:    flag for global or local read/write
c                      (default: .false.)
c     lAdInit:         initialisation of corresponding adjoint
c                      variable and write to active file
      character*(*) active_var_file
      _RL     active_var(1-olx:snx+olx,1-oly:sny+oly,nsx,nsy)
      integer irec
      integer myOptimIter
      integer mythid
      logical doglobalread
      logical lAdInit
      _RL     dummy

C     !LOCAL VARIABLES:
c     == local variables ==
      integer mynr

c     == end of interface ==
CEOP

      mynr = 1
      call ACTIVE_READ_RL( active_var_file, active_var, doglobalread,
     &                     lAdInit, irec, mynr,
     &                     FORWARD_SIMULATION, myOptimIter, mythid)

      return
      end


c ================================================================== CBOP C !ROUTINE: active_read_xyz C !INTERFACE: subroutine ACTIVE_READ_XYZ( I active_var_file, O active_var, I irec, I doglobalread, I lAdInit, I myOptimIter, I mythid I , dummy & ) C !DESCRIPTION: \bv c ================================================================== c SUBROUTINE active_read_xyz c ================================================================== c o Read an active 3D variable from file. c started: Christian Eckert eckert@mit.edu 30-Jun-1999 c ================================================================== c SUBROUTINE active_read_xyz c ================================================================== C \ev C !USES: implicit none c == global variables == #include "EEPARAMS.h" #include "SIZE.h" C !INPUT/OUTPUT PARAMETERS: c == routine arguments == c active_var_file: filename c active_var: array c irec: record number c myOptimIter: number of optimization iteration (default: 0) c mythid: thread number for this instance c doglobalread: flag for global or local read/write c (default: .false.) c lAdInit: initialisation of corresponding adjoint c variable and write to active file character*(*) active_var_file _RL active_var(1-olx:snx+olx,1-oly:sny+oly,nr,nsx,nsy) integer irec integer myOptimIter integer mythid logical doglobalread logical lAdInit _RL dummy C !LOCAL VARIABLES: c == local variables == integer mynr c == end of interface == CEOP mynr = nr call ACTIVE_READ_RL( active_var_file, active_var, doglobalread, & lAdInit, irec, mynr, & FORWARD_SIMULATION, myOptimIter, mythid) return end


c ================================================================== CBOP C !ROUTINE: active_read_xz C !INTERFACE: subroutine ACTIVE_READ_XZ( I active_var_file, O active_var, I irec, I doglobalread, I lAdInit, I myOptimIter, I mythid I , dummy & ) C !DESCRIPTION: \bv c ================================================================== c SUBROUTINE active_read_xz c ================================================================== c o Read an active 2D xz-slice from file. c started: heimbach@mit.edu 05-Mar-2001 c ================================================================== c SUBROUTINE active_read_xz c ================================================================== C \ev C !USES: implicit none c == global variables == #include "EEPARAMS.h" #include "SIZE.h" C !INPUT/OUTPUT PARAMETERS: c == routine arguments == c active_var_file: filename c active_var: array c irec: record number c myOptimIter: number of optimization iteration (default: 0) c mythid: thread number for this instance c doglobalread: flag for global or local read/write c (default: .false.) c lAdInit: initialisation of corresponding adjoint c variable and write to active file character*(*) active_var_file _RL active_var(1-olx:snx+olx,nsx,nsy) integer irec integer myOptimIter integer mythid logical doglobalread logical lAdInit _RL dummy C !LOCAL VARIABLES: c == local variables == integer mynr c == end of interface == CEOP mynr = nr call ACTIVE_READ_XZ_RL( active_var_file, active_var, doglobalread, & lAdInit, irec, mynr, & FORWARD_SIMULATION, myOptimIter, mythid) return end


c ================================================================== CBOP C !ROUTINE: active_read_yz C !INTERFACE: subroutine ACTIVE_READ_YZ( I active_var_file, O active_var, I irec, I doglobalread, I lAdInit, I myOptimIter, I mythid I , dummy & ) C !DESCRIPTION: \bv c ================================================================== c SUBROUTINE active_read_yz c ================================================================== c o Read an active 2D yz-slice from file. c started: heimbach@mit.edu 05-Mar-2001 c ================================================================== c SUBROUTINE active_read_yz c ================================================================== C \ev C !USES: implicit none c == global variables == #include "EEPARAMS.h" #include "SIZE.h" C !INPUT/OUTPUT PARAMETERS: c == routine arguments == c active_var_file: filename c active_var: array c irec: record number c myOptimIter: number of optimization iteration (default: 0) c mythid: thread number for this instance c doglobalread: flag for global or local read/write c (default: .false.) c lAdInit: initialisation of corresponding adjoint c variable and write to active file character*(*) active_var_file _RL active_var(1-oly:sny+oly,nsx,nsy) integer irec integer myOptimIter integer mythid logical doglobalread logical lAdInit _RL dummy C !LOCAL VARIABLES: c == local variables == integer mynr c == end of interface == CEOP mynr = nr call ACTIVE_READ_YZ_RL( active_var_file, active_var, doglobalread, & lAdInit, irec, mynr, & FORWARD_SIMULATION, myOptimIter, mythid) return end


c ================================================================== CBOP C !ROUTINE: active_write_xy C !INTERFACE: subroutine ACTIVE_WRITE_XY( I active_var_file, I active_var, I irec, I myOptimIter, I mythid I , dummy & ) C !DESCRIPTION: \bv c ================================================================== c SUBROUTINE active_write_xy c ================================================================== c o Write an active 2D variable to a file. c started: Christian Eckert eckert@mit.edu 30-Jun-1999 c ================================================================== c SUBROUTINE active_write_xy c ================================================================== C \ev C !USES: implicit none c == global variables == #include "EEPARAMS.h" #include "SIZE.h" c == routine arguments == c active_var_file: filename c active_var: array c irec: record number c myOptimIter: number of optimization iteration (default: 0) c mythid: thread number for this instance character*(*) active_var_file _RL active_var(1-olx:snx+olx,1-oly:sny+oly,nsx,nsy) integer irec integer myOptimIter integer mythid _RL dummy C !LOCAL VARIABLES: c == local variables == integer mynr logical globalfile c == end of interface == CEOP mynr = 1 globalfile = .false. call ACTIVE_WRITE_RL( active_var_file, active_var, globalfile, & irec, mynr, & FORWARD_SIMULATION, myOptimIter, mythid ) return end


c ================================================================== CBOP C !ROUTINE: active_write_xyz C !INTERFACE: subroutine ACTIVE_WRITE_XYZ( I active_var_file, I active_var, I irec, I myOptimIter, I mythid I , dummy & ) C !DESCRIPTION: \bv c ================================================================== c SUBROUTINE active_write_xyz c ================================================================== c o Write an active 3D variable to a file. c started: Christian Eckert eckert@mit.edu 30-Jun-1999 c ================================================================== c SUBROUTINE active_write_xyz c ================================================================== C \ev C !USES: implicit none c == global variables == #include "EEPARAMS.h" #include "SIZE.h" c == routine arguments == c active_var_file: filename c active_var: array c irec: record number c myOptimIter: number of optimization iteration (default: 0) c mythid: thread number for this instance character*(*) active_var_file _RL active_var(1-olx:snx+olx,1-oly:sny+oly,nr,nsx,nsy) integer irec integer myOptimIter integer mythid _RL dummy C !LOCAL VARIABLES: c == local variables == integer mynr logical globalfile c == end of interface == CEOP mynr = nr globalfile = .false. call ACTIVE_WRITE_RL(active_var_file, active_var, globalfile, & irec, mynr, & FORWARD_SIMULATION, myOptimIter, mythid) return end


c ================================================================== CBOP C !ROUTINE: active_write_xz C !INTERFACE: subroutine ACTIVE_WRITE_XZ( I active_var_file, I active_var, I irec, I myOptimIter, I mythid I , dummy & ) C !DESCRIPTION: \bv c ================================================================== c SUBROUTINE active_write_xz c ================================================================== c o Write an active 2D xz-slice to a file. c started: heimbach@mit.edu 05-Mar-2001 c ================================================================== c SUBROUTINE active_write_xz c ================================================================== C \ev C !USES: implicit none c == global variables == #include "EEPARAMS.h" #include "SIZE.h" c == routine arguments == c active_var_file: filename c active_var: array c irec: record number c myOptimIter: number of optimization iteration (default: 0) c mythid: thread number for this instance character*(*) active_var_file _RL active_var(1-olx:snx+olx,nsx,nsy) integer irec integer myOptimIter integer mythid _RL dummy C !LOCAL VARIABLES: c == local variables == integer mynr logical globalfile c == end of interface == CEOP mynr = nr globalfile = .false. call ACTIVE_WRITE_XZ_RL( active_var_file, active_var, globalfile, & irec, mynr, & FORWARD_SIMULATION, myOptimIter, mythid ) return end


c ================================================================== CBOP C !ROUTINE: active_write_yz C !INTERFACE: subroutine ACTIVE_WRITE_YZ( I active_var_file, I active_var, I irec, I myOptimIter, I mythid I , dummy & ) C !DESCRIPTION: \bv c ================================================================== c SUBROUTINE active_write_yz c ================================================================== c o Write an active 2D variable to a file. c started: heimbach@mit.edu 05-Mar-2001 c ================================================================== c SUBROUTINE active_write_yz c ================================================================== C \ev C !USES: implicit none c == global variables == #include "EEPARAMS.h" #include "SIZE.h" c == routine arguments == c active_var_file: filename c active_var: array c irec: record number c myOptimIter: number of optimization iteration (default: 0) c mythid: thread number for this instance character*(*) active_var_file _RL active_var(1-oly:sny+oly,nsx,nsy) integer irec integer myOptimIter integer mythid _RL dummy C !LOCAL VARIABLES: c == local variables == integer mynr logical globalfile c == end of interface == CEOP mynr = nr globalfile = .false. call ACTIVE_WRITE_YZ_RL( active_var_file, active_var, globalfile, & irec, mynr, & FORWARD_SIMULATION, myOptimIter, mythid ) return end


c ================================================================== subroutine ACTIVE_READ_TILE_XY( I active_var_file, O active_var, I irec, I doglobalread, I bi, I bj, I lAdInit, I myOptimIter, I mythid & ) c ================================================================== c SUBROUTINE active_read_tile_xy c ================================================================== c c o Read an active 2D variable from file. c c started: Christian Eckert eckert@mit.edu 30-Jun-1999 c c changed: Christian Eckert eckert@mit.edu 11-Feb-2000 c c - Restructured the code in order to create a package c for the MITgcmUV.c c c changed: Christian Eckert eckert@mit.edu 24-Apr-2000 c c - Added routines that do active writes on tiles c instead of a whole thread. c c ================================================================== c SUBROUTINE active_read_tile_xy c ================================================================== implicit none c == global variables == #include "EEPARAMS.h" #include "SIZE.h" c == routine arguments == character*(*) active_var_file _RL active_var(1-olx:snx+olx,1-oly:sny+oly) integer irec integer myOptimIter integer mythid integer bi integer bj logical doglobalread logical lAdInit c == local variables == integer mynr c == end of interface == mynr = 1 call ACTIVE_READ_TILE_RL( I active_var_file, I active_var, I doglobalread, I lAdInit, I irec, I mynr, I bi, I bj, I FORWARD_SIMULATION, I myOptimIter, I mythid & ) return end


subroutine ACTIVE_READ_TILE_XYZ( I active_var_file, O active_var, I irec, I doglobalread, I bi, I bj, I lAdInit, I myOptimIter, I mythid & ) c ================================================================== c SUBROUTINE active_read_tile_xyz c ================================================================== c c o Read an active 3D variable from file. c c started: Christian Eckert eckert@mit.edu 30-Jun-1999 c c changed: Christian Eckert eckert@mit.edu 11-Feb-2000 c c - Restructured the code in order to create a package c for the MITgcmUV.c c c changed: Christian Eckert eckert@mit.edu 24-Apr-2000 c c - Added routines that do active writes on tiles c instead of a whole thread. c c ================================================================== c SUBROUTINE active_read_tile_xyz c ================================================================== implicit none c == global variables == #include "EEPARAMS.h" #include "SIZE.h" c == routine arguments == character*(*) active_var_file _RL active_var(1-olx:snx+olx,1-oly:sny+oly,nr) integer irec integer myOptimIter integer mythid logical doglobalread integer bi integer bj logical lAdInit c == local variables == integer mynr c == end of interface == mynr = nr call ACTIVE_READ_TILE_RL( I active_var_file, I active_var, I doglobalread, I lAdInit, I irec, I mynr, I bi, I bj, I FORWARD_SIMULATION, I myOptimIter, I mythid & ) return end


subroutine ACTIVE_WRITE_TILE_XY( I active_var_file, I active_var, I irec, I bi, I bj, I myOptimIter, I mythid & ) c ================================================================== c SUBROUTINE active_write_tile_xy c ================================================================== c c o Write an active 2D variable to a file. c c started: Christian Eckert eckert@mit.edu 30-Jun-1999 c c changed: Christian Eckert eckert@mit.edu 11-Feb-2000 c c - Restructured the code in order to create a package c for the MITgcmUV.c c c changed: Christian Eckert eckert@mit.edu 24-Apr-2000 c c - Added routines that do active writes on tiles c instead of a whole thread. c c ================================================================== c SUBROUTINE active_write_tile_xy c ================================================================== implicit none c == global variables == #include "EEPARAMS.h" #include "SIZE.h" c == routine arguments == character*(*) active_var_file _RL active_var(1-olx:snx+olx,1-oly:sny+oly) integer irec integer bi integer bj integer myOptimIter integer mythid c == local variables == integer mynr logical globalfile c == end of interface == mynr = 1 globalfile = .false. call ACTIVE_WRITE_TILE_RL( I active_var_file, I active_var, I globalfile, I irec, I mynr, I bi, I bj, I FORWARD_SIMULATION, I myOptimIter, I mythid & ) return end


subroutine ACTIVE_WRITE_TILE_XYZ( I active_var_file, I active_var, I irec, I bi, I bj, I myOptimIter, I mythid & ) c ================================================================== c SUBROUTINE active_write_tile_xyz c ================================================================== c c o Write an active 3D variable to a file. c c started: Christian Eckert eckert@mit.edu 30-Jun-1999 c c changed: Christian Eckert eckert@mit.edu 11-Feb-2000 c c - Restructured the code in order to create a package c for the MITgcmUV.c c c changed: Christian Eckert eckert@mit.edu 24-Apr-2000 c c - Added routines that do active writes on tiles c instead of a whole thread. c c ================================================================== c SUBROUTINE active_write_tile_xyz c ================================================================== implicit none c == global variables == #include "EEPARAMS.h" #include "SIZE.h" c == routine arguments == character*(*) active_var_file _RL active_var(1-olx:snx+olx,1-oly:sny+oly,nr) integer irec integer bi integer bj integer myOptimIter integer mythid c == local variables == integer mynr logical globalfile c == end of interface == mynr = nr globalfile = .false. call ACTIVE_WRITE_TILE_RL( I active_var_file, I active_var, I globalfile, I irec, I mynr, I bi, I bj, I FORWARD_SIMULATION, I myOptimIter, I mythid & ) return end