pkg/ptracers/ptracers_write_state.F

C $Header: /u/gcmpack/MITgcm/pkg/ptracers/ptracers_write_state.F,v 1.7 2004/10/10 06:08:50 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     !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

      LOGICAL  DIFFERENT_MULTIPLE
      EXTERNAL DIFFERENT_MULTIPLE
      INTEGER  IO_ERRCOUNT
      EXTERNAL IO_ERRCOUNT

      IF (
     &     DIFFERENT_MULTIPLE(PTRACERS_dumpFreq,myTime,
     &     myTime-deltaTClock) .OR. 
     &     myTime.EQ.endTime .OR.
     &     myTime.EQ.startTime
     &     ) THEN
       
C     Write to files
       _BARRIER
       _BEGIN_MASTER( myThid )

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

       IF (PTRACERS_write_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
C     DIFFERENT_MULTIPLE
      ENDIF

#endif /* ALLOW_PTRACERS */

      RETURN
      END
1	mlosch	1.8	C $Header: /u/gcmpack/MITgcm/pkg/ptracers/ptracers_write_state.F,v 1.7 2004/10/10 06:08:50 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	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	mlosch	1.8
44			LOGICAL DIFFERENT_MULTIPLE
45			EXTERNAL DIFFERENT_MULTIPLE
46			INTEGER IO_ERRCOUNT
47			EXTERNAL IO_ERRCOUNT
48
49			IF (
50			& DIFFERENT_MULTIPLE(PTRACERS_dumpFreq,myTime,
51			& myTime-deltaTClock) .OR.
52			& myTime.EQ.endTime .OR.
53			& myTime.EQ.startTime
54			& ) THEN
55
56			C Write to files
57			_BARRIER
58			_BEGIN_MASTER( myThid )
59
60	edhill	1.4	#ifdef ALLOW_MNC
61	mlosch	1.8	IF (useMNC .AND. PTRACERS_write_mnc) THEN
62	edhill	1.4	CALL MNC_CW_SET_UDIM('ptracers', -1, myThid)
63	edhill	1.6	CALL MNC_CW_I_W_S('I','ptracers',0,0,'iter',myIter,myThid)
64	edhill	1.4	CALL MNC_CW_SET_UDIM('ptracers', 0, myThid)
65	mlosch	1.8	DO iTracer = 1,PTRACERS_numInUse
66			CALL MNC_CW_RL_W('D','ptracers',0,0,PTRACERS_names(iTracer),
67			& pTracer(1-OLx,1-OLy,1,1,1,iTracer),myThid)
68	edhill	1.4	ENDDO
69	mlosch	1.8	ENDIF
70	edhill	1.4	#endif /* ALLOW_MNC */
71
72	mlosch	1.8	IF (PTRACERS_write_mdsio) THEN
73	adcroft	1.1
74	edhill	1.4	C Loop over tracers
75			DO iTracer=1,PTRACERS_numInUse
76	adcroft	1.1
77			#ifdef MULTIPLE_RECORD_STATE_FILES
78	mlosch	1.8	C Write each snap-shot as a record in a time-history file
79			IF (PTRACERS_useRecords) THEN
80			C Write each passive tracer as a record
81			WRITE(suff,'(A)') 'PTRACERS'
82			iRec = int ( (myCurrentTime-startTime)
83			& / PTRACERS_dumpFreq + 1.5 )
84			iRec = (iRec-1)*PTRACERS_num + iTracer + 1
85			ELSE
86			C Write each passive tracer in its own file
87			WRITE(pref,'(A7,I2.2)') 'PTRACER',iTracer
88			iRec = int ( (myCurrentTime-startTime)
89			& / PTRACERS_dumpFreq + 1.5 )
90			ENDIF
91			#else
92	edhill	1.4	C Write each snap-shot as a new file with a 10-digit suffix to
93	mlosch	1.8	C indicate time-step number
94			IF (PTRACERS_useRecords) THEN
95			C Write each passive tracer as a record
96			WRITE(suff,'(A,I10.10)') 'PTRACERS',myIter
97			iRec=iTracer
98			ELSE
99			C Write each passive tracer in its own file
100			WRITE(suff,'(A7,I2.2,A1,I10.10)')
101			& 'PTRACER',iTracer,'.',myIter
102			iRec=1
103			ENDIF
104	adcroft	1.1	#endif /* MULTIPLE_RECORD_STATE_FILES */
105	mlosch	1.8
106			CALL WRITE_REC_XYZ_RL(suff,
107			& pTracer(1-Olx,1-Oly,1,1,1,iTracer),iRec,myIter,myThid)
108
109			C End of tracer loop
110	edhill	1.4	ENDDO
111
112	mlosch	1.8	ENDIF
113
114			_END_MASTER( myThid )
115			_BARRIER
116			C DIFFERENT_MULTIPLE
117	edhill	1.4	ENDIF
118	mlosch	1.8
119	adcroft	1.1	#endif /* ALLOW_PTRACERS */
120
121			RETURN
122			END