model/src/set_parms.F

C $Header: /u/gcmpack/MITgcm/model/src/set_parms.F,v 1.7 2010/01/06 00:49:35 jmc Exp $
C $Name:  $

#include "PACKAGES_CONFIG.h"
#include "CPP_OPTIONS.h"

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C     !ROUTINE: SET_PARMS
C     !INTERFACE:
      SUBROUTINE SET_PARMS( myThid )

C     !DESCRIPTION:
C     Set model "parameters" that might depend on the use of some pkgs;
C     called from INITIALISE_FIXED, after INI_PARMS & PACKAGES_READPARAMS
C     NOTES: After leaving this S/R, parameters will not change anymore.

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

C     !INPUT/OUTPUT PARAMETERS:
C     myThid :: My Thread Id number
      INTEGER myThid

C     !FUNCTIONS:
c     INTEGER  ILNBLNK
c     EXTERNAL ILNBLNK

C     !LOCAL VARIABLES:
      CHARACTER*(MAX_LEN_MBUF) msgBuf
      _RL tmpVar
CEOP

      _BEGIN_MASTER(myThid)

      IF ( useOffLine ) THEN
        WRITE(msgBuf,'(A,A)') 'S/R SET_PARMS: ',
     &    ' Off-Line => turn off Temp,Salt & Mom_Stepping flags'
        CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &                      SQUEEZE_RIGHT , 1)
        tempStepping = .FALSE.
        saltStepping = .FALSE.
        momStepping  = .FALSE.
      ENDIF

C--   Set (or reset) On/Off flags :

C--   On/Off flags for each terms of the momentum equation
      nonHydrostatic   = momStepping .AND. nonHydrostatic
      quasiHydrostatic = momStepping .AND. quasiHydrostatic
      momAdvection = momStepping .AND. momAdvection
      momViscosity = momStepping .AND. momViscosity
      momForcing   = momStepping .AND. momForcing
      useCoriolis  = momStepping .AND. useCoriolis
      use3dCoriolis= useCoriolis .AND. use3dCoriolis
      useCDscheme  = momStepping .AND. useCDscheme
      momPressureForcing= momStepping .AND. momPressureForcing
      implicitIntGravWave=momPressureForcing .AND. implicitIntGravWave
      momImplVertAdv   = momAdvection .AND. momImplVertAdv
      implicitViscosity= momViscosity .AND. implicitViscosity
      use3Dsolver      = nonHydrostatic.OR. implicitIntGravWave

C--   Free-surface & pressure method
      IF ( selectNHfreeSurf.NE.0 .AND.
     &      ( .NOT.nonHydrostatic .OR. usingPCoords
     &        .OR. .NOT.exactConserv
     &      ) ) THEN
        WRITE(msgBuf,'(2A)') '** WARNING ** SET_PARMS: ',
     &                       'reset selectNHfreeSurf to zero'
        CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
     &                      SQUEEZE_RIGHT, myThid )
        selectNHfreeSurf = 0
      ENDIF
C--   Set default Vorticity-Term Scheme:
      IF ( vectorInvariantMomentum ) THEN
        IF ( selectVortScheme.EQ.UNSET_I ) THEN
          selectVortScheme = 1
          IF ( upwindVorticity )    selectVortScheme = 0
          IF ( highOrderVorticity ) selectVortScheme = 0
        ENDIF
      ELSEIF ( selectVortScheme.NE.UNSET_I ) THEN
        WRITE(msgBuf,'(A,A)') '** WARNING ** SET_PARMS: ',
     &   'Vector-Invariant Momentum unused => ignore selectVortScheme'
        CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
     &                      SQUEEZE_RIGHT, myThid )
      ENDIF
C--   Momentum viscosity on/off flag.
      IF ( momViscosity        ) THEN
       vfFacMom = 1. _d 0
      ELSE
       vfFacMom = 0. _d 0
      ENDIF
C--   Momentum advection on/off flag.
      IF ( momAdvection        ) THEN
       afFacMom = 1. _d 0
      ELSE
       afFacMom = 0. _d 0
      ENDIF
C--   Momentum forcing on/off flag.
      IF ( momForcing ) THEN
       foFacMom = 1. _d 0
      ELSE
       foFacMom = 0. _d 0
      ENDIF
C--   Coriolis term on/off flag.
      IF ( useCoriolis ) THEN
       cfFacMom = 1. _d 0
      ELSE
       cfFacMom = 0. _d 0
      ENDIF
C--   Pressure term on/off flag.
      IF ( momPressureForcing ) THEN
       pfFacMom = 1. _d 0
      ELSE
       pfFacMom = 0. _d 0
      ENDIF
C--   Metric terms on/off flag.
      IF ( metricTerms ) THEN
       mTFacMom = 1. _d 0
      ELSE
       mTFacMom = 0. _d 0
      ENDIF

C--   Advection and Forcing for Temp and salt  on/off flags
      tempAdvection = tempStepping .AND. tempAdvection
      tempForcing   = tempStepping .AND. tempForcing
      saltAdvection = saltStepping .AND. saltAdvection
      saltForcing   = saltStepping .AND. saltForcing
      tempImplVertAdv = tempAdvection .AND. tempImplVertAdv
      saltImplVertAdv = saltAdvection .AND. saltImplVertAdv

C--   Dynamically Active Tracers : set flags
      tempIsActiveTr = momPressureForcing .AND. tempAdvection
      saltIsActiveTr = momPressureForcing .AND. saltAdvection
      IF ( eosType.EQ.'IDEALGAS' .AND. atm_Rq.EQ.0. ) THEN
        saltIsActiveTr = .FALSE.
      ELSEIF ( eosType.EQ.'LINEAR' ) THEN
        IF ( tAlpha.EQ.0. ) tempIsActiveTr = .FALSE.
        IF ( sBeta .EQ.0. ) saltIsActiveTr = .FALSE.
      ENDIF

C--   When using the dynamical pressure in EOS (with Z-coord.),
C     needs to activate specific part of the code (restart & exchange)
c     useDynP_inEos_Zc = .FALSE.
      useDynP_inEos_Zc = ( fluidIsWater .AND. usingZCoords
     &              .AND. ( eosType .EQ. 'JMD95P' .OR.
     &                      eosType .EQ. 'UNESCO' .OR.
     &                      eosType .EQ. 'MDJWF'  .OR.
     &                      eosType .EQ. 'TEOS10'      )  )

C--   Adjust parameters related to length of the simulation

C-    Need to adjust endTime for sub-timestep mismatch , since in
C     several places, test for last iteration with time==endTime :
      tmpVar = startTime + deltaTClock*FLOAT(nTimeSteps)
      IF ( endTime.NE.tmpVar ) THEN
       IF ( ABS(endTime-tmpVar).GT.deltaTClock*1. _d -6 ) THEN
        WRITE(msgBuf,'(A,A)') '** WARNING ** SET_PARMS: ',
     &   '(endTime-baseTime) not multiple of time-step'
        CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
     &                      SQUEEZE_RIGHT, myThid )
        WRITE(msgBuf,'(2A,1PE20.13)') '** WARNING ** SET_PARMS: ',
     &   'Previous endTime=', endTime
        CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
     &                      SQUEEZE_RIGHT, myThid )
        WRITE(msgBuf,'(2A,1PE20.13)') '** WARNING ** SET_PARMS: ',
     &   'Adjusted endTime=', tmpVar
        CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
     &                      SQUEEZE_RIGHT, myThid )
       ENDIF
       endTime = tmpVar
      ENDIF

#ifdef ALLOW_LONGSTEP
      IF ( usePTRACERS ) THEN
        CALL LONGSTEP_CHECK_ITERS(myThid)
      ENDIF
#endif /* ALLOW_LONGSTEP */

C--  After this point, main model parameters are not supposed to be modified.
       WRITE(msgBuf,'(A,A)') 'SET_PARMS: done'
       CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &                      SQUEEZE_RIGHT , 1)

      _END_MASTER(myThid)

C--   Everyone else must wait for the parameters to be set
      _BARRIER

      RETURN
      END
1	mlosch	1.8	C $Header: /u/gcmpack/MITgcm/model/src/set_parms.F,v 1.7 2010/01/06 00:49:35 jmc Exp $
2	jmc	1.1	C $Name: $
3
4	jahn	1.5	#include "PACKAGES_CONFIG.h"
5	jmc	1.1	#include "CPP_OPTIONS.h"
6
7			C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
8			CBOP
9			C !ROUTINE: SET_PARMS
10			C !INTERFACE:
11			SUBROUTINE SET_PARMS( myThid )
12
13			C !DESCRIPTION:
14			C Set model "parameters" that might depend on the use of some pkgs;
15			C called from INITIALISE_FIXED, after INI_PARMS & PACKAGES_READPARAMS
16			C NOTES: After leaving this S/R, parameters will not change anymore.
17
18			C !USES:
19			IMPLICIT NONE
20			#include "SIZE.h"
21			#include "EEPARAMS.h"
22			#include "PARAMS.h"
23	jmc	1.4	#include "EOS.h"
24	jmc	1.1
25			C !INPUT/OUTPUT PARAMETERS:
26	jmc	1.6	C myThid :: My Thread Id number
27	jmc	1.1	INTEGER myThid
28
29	jmc	1.7	C !FUNCTIONS:
30			c INTEGER ILNBLNK
31			c EXTERNAL ILNBLNK
32
33	jmc	1.1	C !LOCAL VARIABLES:
34			CHARACTER*(MAX_LEN_MBUF) msgBuf
35	jmc	1.7	_RL tmpVar
36	jmc	1.1	CEOP
37
38			_BEGIN_MASTER(myThid)
39
40			IF ( useOffLine ) THEN
41			WRITE(msgBuf,'(A,A)') 'S/R SET_PARMS: ',
42			& ' Off-Line => turn off Temp,Salt & Mom_Stepping flags'
43			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
44			& SQUEEZE_RIGHT , 1)
45			tempStepping = .FALSE.
46			saltStepping = .FALSE.
47			momStepping = .FALSE.
48			ENDIF
49
50			C-- Set (or reset) On/Off flags :
51
52			C-- On/Off flags for each terms of the momentum equation
53			nonHydrostatic = momStepping .AND. nonHydrostatic
54			quasiHydrostatic = momStepping .AND. quasiHydrostatic
55			momAdvection = momStepping .AND. momAdvection
56			momViscosity = momStepping .AND. momViscosity
57			momForcing = momStepping .AND. momForcing
58			useCoriolis = momStepping .AND. useCoriolis
59	jmc	1.2	use3dCoriolis= useCoriolis .AND. use3dCoriolis
60	jmc	1.1	useCDscheme = momStepping .AND. useCDscheme
61			momPressureForcing= momStepping .AND. momPressureForcing
62			implicitIntGravWave=momPressureForcing .AND. implicitIntGravWave
63			momImplVertAdv = momAdvection .AND. momImplVertAdv
64			implicitViscosity= momViscosity .AND. implicitViscosity
65			use3Dsolver = nonHydrostatic.OR. implicitIntGravWave
66	jmc	1.6
67			C-- Free-surface & pressure method
68			IF ( selectNHfreeSurf.NE.0 .AND.
69			& ( .NOT.nonHydrostatic .OR. usingPCoords
70			& .OR. .NOT.exactConserv
71			& ) ) THEN
72			WRITE(msgBuf,'(2A)') ' WARNING SET_PARMS: ',
73			& 'reset selectNHfreeSurf to zero'
74			CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
75			& SQUEEZE_RIGHT, myThid )
76			selectNHfreeSurf = 0
77			ENDIF
78	jmc	1.3	C-- Set default Vorticity-Term Scheme:
79			IF ( vectorInvariantMomentum ) THEN
80			IF ( selectVortScheme.EQ.UNSET_I ) THEN
81			selectVortScheme = 1
82			IF ( upwindVorticity ) selectVortScheme = 0
83			IF ( highOrderVorticity ) selectVortScheme = 0
84			ENDIF
85			ELSEIF ( selectVortScheme.NE.UNSET_I ) THEN
86			WRITE(msgBuf,'(A,A)') ' WARNING SET_PARMS: ',
87			& 'Vector-Invariant Momentum unused => ignore selectVortScheme'
88	jmc	1.6	CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
89			& SQUEEZE_RIGHT, myThid )
90	jmc	1.3	ENDIF
91	jmc	1.1	C-- Momentum viscosity on/off flag.
92			IF ( momViscosity ) THEN
93	jmc	1.6	vfFacMom = 1. _d 0
94	jmc	1.1	ELSE
95	jmc	1.6	vfFacMom = 0. _d 0
96	jmc	1.1	ENDIF
97			C-- Momentum advection on/off flag.
98			IF ( momAdvection ) THEN
99	jmc	1.6	afFacMom = 1. _d 0
100	jmc	1.1	ELSE
101	jmc	1.6	afFacMom = 0. _d 0
102	jmc	1.1	ENDIF
103			C-- Momentum forcing on/off flag.
104			IF ( momForcing ) THEN
105	jmc	1.6	foFacMom = 1. _d 0
106	jmc	1.1	ELSE
107	jmc	1.6	foFacMom = 0. _d 0
108	jmc	1.1	ENDIF
109			C-- Coriolis term on/off flag.
110			IF ( useCoriolis ) THEN
111	jmc	1.6	cfFacMom = 1. _d 0
112	jmc	1.1	ELSE
113	jmc	1.6	cfFacMom = 0. _d 0
114	jmc	1.1	ENDIF
115			C-- Pressure term on/off flag.
116			IF ( momPressureForcing ) THEN
117	jmc	1.6	pfFacMom = 1. _d 0
118	jmc	1.1	ELSE
119	jmc	1.6	pfFacMom = 0. _d 0
120	jmc	1.1	ENDIF
121			C-- Metric terms on/off flag.
122			IF ( metricTerms ) THEN
123	jmc	1.6	mTFacMom = 1. _d 0
124	jmc	1.1	ELSE
125	jmc	1.6	mTFacMom = 0. _d 0
126	jmc	1.1	ENDIF
127
128			C-- Advection and Forcing for Temp and salt on/off flags
129			tempAdvection = tempStepping .AND. tempAdvection
130			tempForcing = tempStepping .AND. tempForcing
131			saltAdvection = saltStepping .AND. saltAdvection
132			saltForcing = saltStepping .AND. saltForcing
133			tempImplVertAdv = tempAdvection .AND. tempImplVertAdv
134			saltImplVertAdv = saltAdvection .AND. saltImplVertAdv
135
136	jmc	1.4	C-- Dynamically Active Tracers : set flags
137			tempIsActiveTr = momPressureForcing .AND. tempAdvection
138			saltIsActiveTr = momPressureForcing .AND. saltAdvection
139			IF ( eosType.EQ.'IDEALGAS' .AND. atm_Rq.EQ.0. ) THEN
140			saltIsActiveTr = .FALSE.
141			ELSEIF ( eosType.EQ.'LINEAR' ) THEN
142			IF ( tAlpha.EQ.0. ) tempIsActiveTr = .FALSE.
143			IF ( sBeta .EQ.0. ) saltIsActiveTr = .FALSE.
144			ENDIF
145
146	jmc	1.1	C-- When using the dynamical pressure in EOS (with Z-coord.),
147			C needs to activate specific part of the code (restart & exchange)
148			c useDynP_inEos_Zc = .FALSE.
149			useDynP_inEos_Zc = ( fluidIsWater .AND. usingZCoords
150			& .AND. ( eosType .EQ. 'JMD95P' .OR.
151			& eosType .EQ. 'UNESCO' .OR.
152	mlosch	1.8	& eosType .EQ. 'MDJWF' .OR.
153			& eosType .EQ. 'TEOS10' ) )
154	jmc	1.1
155	jmc	1.7	C-- Adjust parameters related to length of the simulation
156
157			C- Need to adjust endTime for sub-timestep mismatch , since in
158			C several places, test for last iteration with time==endTime :
159			tmpVar = startTime + deltaTClock*FLOAT(nTimeSteps)
160			IF ( endTime.NE.tmpVar ) THEN
161			IF ( ABS(endTime-tmpVar).GT.deltaTClock*1. _d -6 ) THEN
162			WRITE(msgBuf,'(A,A)') ' WARNING SET_PARMS: ',
163			& '(endTime-baseTime) not multiple of time-step'
164			CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
165			& SQUEEZE_RIGHT, myThid )
166			WRITE(msgBuf,'(2A,1PE20.13)') ' WARNING SET_PARMS: ',
167			& 'Previous endTime=', endTime
168			CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
169			& SQUEEZE_RIGHT, myThid )
170			WRITE(msgBuf,'(2A,1PE20.13)') ' WARNING SET_PARMS: ',
171			& 'Adjusted endTime=', tmpVar
172			CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
173			& SQUEEZE_RIGHT, myThid )
174			ENDIF
175			endTime = tmpVar
176			ENDIF
177
178	jahn	1.5	#ifdef ALLOW_LONGSTEP
179			IF ( usePTRACERS ) THEN
180			CALL LONGSTEP_CHECK_ITERS(myThid)
181			ENDIF
182			#endif /* ALLOW_LONGSTEP */
183
184	jmc	1.1	C-- After this point, main model parameters are not supposed to be modified.
185			WRITE(msgBuf,'(A,A)') 'SET_PARMS: done'
186			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
187			& SQUEEZE_RIGHT , 1)
188
189			_END_MASTER(myThid)
190
191			C-- Everyone else must wait for the parameters to be set
192			_BARRIER
193
194			RETURN
195			END