--- MITgcm/eesupp/src/exch_rx_recv_get_x.template 2001/05/29 14:06:38 1.1 +++ MITgcm/eesupp/src/exch_rx_recv_get_x.template 2001/09/21 03:55:50 1.2 @@ -1,40 +1,48 @@ -C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/eesupp/src/exch_rx_recv_get_x.template,v 1.1 2001/05/29 14:06:38 adcroft Exp $ +C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/eesupp/src/exch_rx_recv_get_x.template,v 1.2 2001/09/21 03:55:50 cnh Exp $ C $Name: $ #include "CPP_EEOPTIONS.h" +CBOP +C !ROUTINE: EXCH_RX_RECV_GET_X + +C !INTERFACE: SUBROUTINE EXCH_RX_RECV_GET_X( array, I myOLw, myOLe, myOLs, myOLn, myNz, I exchWidthX, exchWidthY, I theSimulationMode, theCornerMode, myThid ) -C /==========================================================\ -C | SUBROUTINE RECV_RX_GET_X | -C | o "Send" or "put" X edges for RX array. | -C |==========================================================| -C | Routine that invokes actual message passing send or | -C | direct "put" of data to update X faces of an XY[R] array.| -C \==========================================================/ IMPLICIT NONE +C !DESCRIPTION: +C *==========================================================* +C | SUBROUTINE RECV_RX_GET_X +C | o "Send" or "put" X edges for RX array. +C *==========================================================* +C | Routine that invokes actual message passing send or +C | direct "put" of data to update X faces of an XY[R] array. +C *==========================================================* + +C !USES: C == Global variables == #include "SIZE.h" #include "EEPARAMS.h" #include "EESUPPORT.h" #include "EXCH.h" +C !INPUT/OUTPUT PARAMETERS: C == Routine arguments == -C array - Array with edges to exchange. -C myOLw - West, East, North and South overlap region sizes. +C array :: Array with edges to exchange. +C myOLw :: West, East, North and South overlap region sizes. C myOLe C myOLn C myOLs -C exchWidthX - Width of data region exchanged. +C exchWidthX :: Width of data region exchanged. C exchWidthY -C theSimulationMode - Forward or reverse mode exchange ( provides +C theSimulationMode :: Forward or reverse mode exchange ( provides C support for adjoint integration of code. ) -C theCornerMode - Flag indicating whether corner updates are +C theCornerMode :: Flag indicating whether corner updates are C needed. -C myThid - Thread number of this instance of S/R EXCH... -C eBl - Edge buffer level +C myThid :: Thread number of this instance of S/R EXCH... +C eBl :: Edge buffer level INTEGER myOLw INTEGER myOLe INTEGER myOLs @@ -48,19 +56,19 @@ INTEGER theSimulationMode INTEGER theCornerMode INTEGER myThid -CEndOfInterface +C !LOCAL VARIABLES: C == Local variables == -C I, J, K, iMin, iMax, iB - Loop counters and extents +C I, J, K, iMin, iMax, iB :: Loop counters and extents C bi, bj -C biW, bjW - West tile indices -C biE, bjE - East tile indices -C eBl - Current exchange buffer level -C theProc, theTag, theType, - Variables used in message building +C biW, bjW :: West tile indices +C biE, bjE :: East tile indices +C eBl :: Current exchange buffer level +C theProc, theTag, theType, :: Variables used in message building C theSize -C westCommMode - Working variables holding type -C eastCommMode of communication a particular -C tile face uses. +C westCommMode :: Working variables holding type +C eastCommMode of communication a particular +C tile face uses. INTEGER I, J, K, iMin, iMax, iB, iB0 INTEGER bi, bj, biW, bjW, biE, bjE INTEGER eBl @@ -71,6 +79,7 @@ INTEGER theProc, theTag, theType, theSize INTEGER mpiStatus(MPI_STATUS_SIZE,4), mpiRc #endif +CEOP C-- Under a "put" scenario we