pkg/ptracers/ptracers_write_state.F

C $Header: /u/gcmpack/MITgcm/pkg/ptracers/ptracers_write_state.F,v 1.14 2005/08/24 23:23:34 jmc Exp $
C $Name:  $

#include "PTRACERS_OPTIONS.h"

CBOP
C     !ROUTINE: PTRACERS_WRITE_STATE

C     !INTERFACE:
      SUBROUTINE PTRACERS_WRITE_STATE( 
     I     myIter, myTime, myThid )

C     !DESCRIPTION:
C     Calculates tendancy for passive tracers and integrates forward in
C     time.

C     !USES:
      IMPLICIT NONE
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "PTRACERS_SIZE.h"
#include "PTRACERS.h"

C     !INPUT PARAMETERS:
C     myIter    :: time-step number
C     myTime    :: model time
C     myThid    :: thread number
      INTEGER myIter
      _RL myTime
      INTEGER myThid
CEOP

#ifdef ALLOW_PTRACERS

C     !LOCAL VARIABLES:
C     iTracer   :: loop indices
C     suff      :: character buffer for creating suffix in filename
C     iRec      :: record number
      INTEGER iTracer
      CHARACTER*(MAX_LEN_MBUF) suff
      INTEGER iRec
      CHARACTER*(1) pf

      LOGICAL  DIFFERENT_MULTIPLE
      EXTERNAL DIFFERENT_MULTIPLE
      INTEGER  IO_ERRCOUNT
      EXTERNAL IO_ERRCOUNT

      IF ( DIFFERENT_MULTIPLE( PTRACERS_dumpFreq, myTime, deltaTClock )
     &  .OR. dumpInitAndLast.AND.( myTime.EQ.endTime .OR.
     &                             myTime.EQ.startTime  )
     &   ) THEN
       
        IF ( writeBinaryPrec .EQ. precFloat64 ) THEN
          pf(1:1) = 'D'
        ELSE
          pf(1:1) = 'R'
        ENDIF

C     Write to files
       _BARRIER
       _BEGIN_MASTER( myThid )

#ifdef ALLOW_MNC
       IF ( PTRACERS_snapshot_mnc ) THEN
        CALL MNC_CW_SET_UDIM('ptracers', -1, myThid)
        CALL MNC_CW_RL_W_S('D','ptracers',0,0,'T',myTime,myThid)
        CALL MNC_CW_SET_UDIM('ptracers', 0, myThid)
        CALL MNC_CW_I_W_S('I','ptracers',0,0,'iter',myIter,myThid)
        DO iTracer = 1,PTRACERS_numInUse
         CALL MNC_CW_RL_W(pf,'ptracers',0,0,PTRACERS_names(iTracer),
     &        pTracer(1-OLx,1-OLy,1,1,1,iTracer),myThid)
        ENDDO
       ENDIF
#endif /*  ALLOW_MNC  */

       IF ( PTRACERS_snapshot_mdsio ) THEN

C       Loop over tracers
        DO iTracer=1,PTRACERS_numInUse

#ifdef MULTIPLE_RECORD_STATE_FILES
C     Write each snap-shot as a record in a time-history file
         IF (PTRACERS_useRecords) THEN
C     Write each passive tracer as a record
          WRITE(suff,'(A)') 'PTRACERS'
          iRec = int ( (myCurrentTime-startTime) 
     &         / PTRACERS_dumpFreq + 1.5 )
          iRec = (iRec-1)*PTRACERS_num + iTracer + 1
         ELSE
C     Write each passive tracer in its own file
          WRITE(pref,'(A7,I2.2)') 'PTRACER',iTracer
          iRec = int ( (myCurrentTime-startTime) 
     &         / PTRACERS_dumpFreq + 1.5 )
         ENDIF
#else 
C         Write each snap-shot as a new file with a 10-digit suffix to
C     indicate time-step number
         IF (PTRACERS_useRecords) THEN
C     Write each passive tracer as a record
          WRITE(suff,'(A,I10.10)') 'PTRACERS',myIter
          iRec=iTracer
         ELSE
C     Write each passive tracer in its own file
          WRITE(suff,'(A7,I2.2,A1,I10.10)') 
     &         'PTRACER',iTracer,'.',myIter
          iRec=1
         ENDIF
#endif /* MULTIPLE_RECORD_STATE_FILES */
         
         CALL WRITE_REC_XYZ_RL(suff,
     &        pTracer(1-Olx,1-Oly,1,1,1,iTracer),iRec,myIter,myThid)
         
C     End of tracer loop
        ENDDO
        
       ENDIF

       _END_MASTER( myThid )
       _BARRIER
      ENDIF

#endif /* ALLOW_PTRACERS */

      RETURN
      END
1	edhill	1.15	C $Header: /u/gcmpack/MITgcm/pkg/ptracers/ptracers_write_state.F,v 1.14 2005/08/24 23:23:34 jmc Exp $
2	dimitri	1.2	C $Name: $
3	adcroft	1.1
4			#include "PTRACERS_OPTIONS.h"
5
6			CBOP
7	edhill	1.4	C !ROUTINE: PTRACERS_WRITE_STATE
8	adcroft	1.1
9	edhill	1.4	C !INTERFACE:
10	mlosch	1.8	SUBROUTINE PTRACERS_WRITE_STATE(
11			I myIter, myTime, myThid )
12	adcroft	1.1
13	edhill	1.4	C !DESCRIPTION:
14			C Calculates tendancy for passive tracers and integrates forward in
15			C time.
16	adcroft	1.1
17	edhill	1.4	C !USES:
18	adcroft	1.1	IMPLICIT NONE
19			#include "SIZE.h"
20			#include "EEPARAMS.h"
21	edhill	1.4	#include "PARAMS.h"
22	jmc	1.3	#include "PTRACERS_SIZE.h"
23	adcroft	1.1	#include "PTRACERS.h"
24
25	edhill	1.4	C !INPUT PARAMETERS:
26			C myIter :: time-step number
27			C myTime :: model time
28			C myThid :: thread number
29	adcroft	1.1	INTEGER myIter
30			_RL myTime
31			INTEGER myThid
32	edhill	1.4	CEOP
33	adcroft	1.1
34			#ifdef ALLOW_PTRACERS
35
36	edhill	1.4	C !LOCAL VARIABLES:
37			C iTracer :: loop indices
38			C suff :: character buffer for creating suffix in filename
39			C iRec :: record number
40	adcroft	1.1	INTEGER iTracer
41			CHARACTER*(MAX_LEN_MBUF) suff
42			INTEGER iRec
43	edhill	1.15	CHARACTER*(1) pf
44	mlosch	1.8
45	jmc	1.11	LOGICAL DIFFERENT_MULTIPLE
46			EXTERNAL DIFFERENT_MULTIPLE
47	mlosch	1.8	INTEGER IO_ERRCOUNT
48			EXTERNAL IO_ERRCOUNT
49
50	jmc	1.11	IF ( DIFFERENT_MULTIPLE( PTRACERS_dumpFreq, myTime, deltaTClock )
51	jmc	1.14	& .OR. dumpInitAndLast.AND.( myTime.EQ.endTime .OR.
52			& myTime.EQ.startTime )
53	jmc	1.11	& ) THEN
54	mlosch	1.8
55	edhill	1.15	IF ( writeBinaryPrec .EQ. precFloat64 ) THEN
56			pf(1:1) = 'D'
57			ELSE
58			pf(1:1) = 'R'
59			ENDIF
60
61	mlosch	1.8	C Write to files
62			_BARRIER
63			_BEGIN_MASTER( myThid )
64
65	edhill	1.4	#ifdef ALLOW_MNC
66	edhill	1.13	IF ( PTRACERS_snapshot_mnc ) THEN
67	edhill	1.4	CALL MNC_CW_SET_UDIM('ptracers', -1, myThid)
68	edhill	1.12	CALL MNC_CW_RL_W_S('D','ptracers',0,0,'T',myTime,myThid)
69	edhill	1.4	CALL MNC_CW_SET_UDIM('ptracers', 0, myThid)
70	edhill	1.12	CALL MNC_CW_I_W_S('I','ptracers',0,0,'iter',myIter,myThid)
71	mlosch	1.8	DO iTracer = 1,PTRACERS_numInUse
72	edhill	1.15	CALL MNC_CW_RL_W(pf,'ptracers',0,0,PTRACERS_names(iTracer),
73	mlosch	1.8	& pTracer(1-OLx,1-OLy,1,1,1,iTracer),myThid)
74	edhill	1.4	ENDDO
75	mlosch	1.8	ENDIF
76	edhill	1.4	#endif /* ALLOW_MNC */
77
78	edhill	1.13	IF ( PTRACERS_snapshot_mdsio ) THEN
79	adcroft	1.1
80	edhill	1.4	C Loop over tracers
81			DO iTracer=1,PTRACERS_numInUse
82	adcroft	1.1
83			#ifdef MULTIPLE_RECORD_STATE_FILES
84	mlosch	1.8	C Write each snap-shot as a record in a time-history file
85			IF (PTRACERS_useRecords) THEN
86			C Write each passive tracer as a record
87			WRITE(suff,'(A)') 'PTRACERS'
88			iRec = int ( (myCurrentTime-startTime)
89			& / PTRACERS_dumpFreq + 1.5 )
90			iRec = (iRec-1)*PTRACERS_num + iTracer + 1
91			ELSE
92			C Write each passive tracer in its own file
93			WRITE(pref,'(A7,I2.2)') 'PTRACER',iTracer
94			iRec = int ( (myCurrentTime-startTime)
95			& / PTRACERS_dumpFreq + 1.5 )
96			ENDIF
97			#else
98	edhill	1.4	C Write each snap-shot as a new file with a 10-digit suffix to
99	mlosch	1.8	C indicate time-step number
100			IF (PTRACERS_useRecords) THEN
101			C Write each passive tracer as a record
102			WRITE(suff,'(A,I10.10)') 'PTRACERS',myIter
103			iRec=iTracer
104			ELSE
105			C Write each passive tracer in its own file
106			WRITE(suff,'(A7,I2.2,A1,I10.10)')
107			& 'PTRACER',iTracer,'.',myIter
108			iRec=1
109			ENDIF
110	adcroft	1.1	#endif /* MULTIPLE_RECORD_STATE_FILES */
111	mlosch	1.8
112			CALL WRITE_REC_XYZ_RL(suff,
113			& pTracer(1-Olx,1-Oly,1,1,1,iTracer),iRec,myIter,myThid)
114
115			C End of tracer loop
116	edhill	1.4	ENDDO
117
118	mlosch	1.8	ENDIF
119
120			_END_MASTER( myThid )
121			_BARRIER
122	edhill	1.4	ENDIF
123	mlosch	1.8
124	adcroft	1.1	#endif /* ALLOW_PTRACERS */
125
126			RETURN
127			END