pkg/ptracers/ptracers_write_state.F

C $Header: /u/gcmpack/MITgcm/pkg/ptracers/ptracers_write_state.F,v 1.15 2005/09/29 12:19:52 edhill 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     === Functions ====
      LOGICAL  DIFFERENT_MULTIPLE
      EXTERNAL DIFFERENT_MULTIPLE
      INTEGER  IO_ERRCOUNT
      EXTERNAL IO_ERRCOUNT

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
#ifdef ALLOW_MNC
      CHARACTER*(1) pf
#endif

      IF ( DIFFERENT_MULTIPLE( PTRACERS_dumpFreq, myTime, deltaTClock )
     &  .OR. dumpInitAndLast.AND.( myTime.EQ.endTime .OR.
     &                             myTime.EQ.startTime  )
     &   ) THEN

C--   Write to files
       _BARRIER

#ifdef ALLOW_MNC
        IF ( writeBinaryPrec .EQ. precFloat64 ) THEN
          pf(1:1) = 'D'
        ELSE
          pf(1:1) = 'R'
        ENDIF

       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 = 1 + NINT( (myTime-startTime) / PTRACERS_dumpFreq )
          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 = 1 + NINT( (myTime-startTime) / PTRACERS_dumpFreq )
         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

       _BARRIER
C--   Writing to files: end
      ENDIF

#endif /* ALLOW_PTRACERS */

      RETURN
      END
1	jmc	1.16	C $Header: /u/gcmpack/MITgcm/pkg/ptracers/ptracers_write_state.F,v 1.15 2005/09/29 12:19:52 edhill 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	jmc	1.16	SUBROUTINE PTRACERS_WRITE_STATE(
11	mlosch	1.8	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	jmc	1.16	C === Functions ====
37			LOGICAL DIFFERENT_MULTIPLE
38			EXTERNAL DIFFERENT_MULTIPLE
39			INTEGER IO_ERRCOUNT
40			EXTERNAL IO_ERRCOUNT
41
42	edhill	1.4	C !LOCAL VARIABLES:
43			C iTracer :: loop indices
44			C suff :: character buffer for creating suffix in filename
45			C iRec :: record number
46	adcroft	1.1	INTEGER iTracer
47			CHARACTER*(MAX_LEN_MBUF) suff
48			INTEGER iRec
49	jmc	1.16	#ifdef ALLOW_MNC
50	edhill	1.15	CHARACTER*(1) pf
51	jmc	1.16	#endif
52	mlosch	1.8
53	jmc	1.11	IF ( DIFFERENT_MULTIPLE( PTRACERS_dumpFreq, myTime, deltaTClock )
54	jmc	1.14	& .OR. dumpInitAndLast.AND.( myTime.EQ.endTime .OR.
55			& myTime.EQ.startTime )
56	jmc	1.11	& ) THEN
57	jmc	1.16
58			C-- Write to files
59			_BARRIER
60
61			#ifdef ALLOW_MNC
62	edhill	1.15	IF ( writeBinaryPrec .EQ. precFloat64 ) THEN
63			pf(1:1) = 'D'
64			ELSE
65			pf(1:1) = 'R'
66			ENDIF
67
68	edhill	1.13	IF ( PTRACERS_snapshot_mnc ) THEN
69	edhill	1.4	CALL MNC_CW_SET_UDIM('ptracers', -1, myThid)
70	edhill	1.12	CALL MNC_CW_RL_W_S('D','ptracers',0,0,'T',myTime,myThid)
71	edhill	1.4	CALL MNC_CW_SET_UDIM('ptracers', 0, myThid)
72	edhill	1.12	CALL MNC_CW_I_W_S('I','ptracers',0,0,'iter',myIter,myThid)
73	mlosch	1.8	DO iTracer = 1,PTRACERS_numInUse
74	edhill	1.15	CALL MNC_CW_RL_W(pf,'ptracers',0,0,PTRACERS_names(iTracer),
75	mlosch	1.8	& pTracer(1-OLx,1-OLy,1,1,1,iTracer),myThid)
76	edhill	1.4	ENDDO
77	mlosch	1.8	ENDIF
78	edhill	1.4	#endif /* ALLOW_MNC */
79
80	edhill	1.13	IF ( PTRACERS_snapshot_mdsio ) THEN
81	adcroft	1.1
82	edhill	1.4	C Loop over tracers
83			DO iTracer=1,PTRACERS_numInUse
84	adcroft	1.1
85			#ifdef MULTIPLE_RECORD_STATE_FILES
86	mlosch	1.8	C Write each snap-shot as a record in a time-history file
87			IF (PTRACERS_useRecords) THEN
88			C Write each passive tracer as a record
89			WRITE(suff,'(A)') 'PTRACERS'
90	jmc	1.16	iRec = 1 + NINT( (myTime-startTime) / PTRACERS_dumpFreq )
91	mlosch	1.8	iRec = (iRec-1)*PTRACERS_num + iTracer + 1
92			ELSE
93			C Write each passive tracer in its own file
94			WRITE(pref,'(A7,I2.2)') 'PTRACER',iTracer
95	jmc	1.16	iRec = 1 + NINT( (myTime-startTime) / PTRACERS_dumpFreq )
96	mlosch	1.8	ENDIF
97	jmc	1.16	#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	jmc	1.16	WRITE(suff,'(A7,I2.2,A1,I10.10)')
107	mlosch	1.8	& 'PTRACER',iTracer,'.',myIter
108			iRec=1
109			ENDIF
110	adcroft	1.1	#endif /* MULTIPLE_RECORD_STATE_FILES */
111	jmc	1.16
112	mlosch	1.8	CALL WRITE_REC_XYZ_RL(suff,
113			& pTracer(1-Olx,1-Oly,1,1,1,iTracer),iRec,myIter,myThid)
114	jmc	1.16
115	mlosch	1.8	C End of tracer loop
116	edhill	1.4	ENDDO
117	jmc	1.16
118	mlosch	1.8	ENDIF
119
120			_BARRIER
121	jmc	1.16	C-- Writing to files: end
122	edhill	1.4	ENDIF
123	mlosch	1.8
124	adcroft	1.1	#endif /* ALLOW_PTRACERS */
125
126			RETURN
127			END