pkg/exf/exf_clim_readparms.F

c $Header: /u/gcmpack/MITgcm/pkg/exf/exf_clim_readparms.F,v 1.6 2004/04/19 22:30:46 mlosch Exp $

#include "EXF_OPTIONS.h"


      subroutine exf_clim_readparms(
     I                               mythid
     &                             )

c     ==================================================================
c     SUBROUTINE exf_clim_readparms
c     ==================================================================
c
c     o This routine initialises the climatologic forcing
c
c     started: Ralf.Giering@FastOpt.de 25-Mai-20000
c
c     ==================================================================
c     SUBROUTINE exf_clim_readparms
c     ==================================================================

      implicit none

c     == global variables ==

#include "EEPARAMS.h"
#include "SIZE.h"
#include "cal.h"
#include "exf.h"
#include "exf_param.h"
#include "exf_clim_param.h"

c     == routine arguments ==

      integer mythid

c     == local variables ==

      integer i
      integer date_array(4), difftime(4)

c     == end of interface ==

c     Surface flux data.
      namelist /exf_clim_nml/
     &     climtempfreeze,
     & climtempstartdate1, climtempstartdate2, climtempperiod,
     & climsaltstartdate1, climsaltstartdate2, climsaltperiod,
     &  climsststartdate1,  climsststartdate2,  climsstperiod,
     &  climsssstartdate1,  climsssstartdate2,  climsssperiod,
     &       climtempfile,       climsaltfile,    climsstfile,
     &        climsssfile,       climsstconst,   climsssconst,
     &     exf_clim_iprec, exf_clim_yftype
#ifdef USE_EXF_INTERPOLATION
     & ,climsst_lon0, climsst_lon_inc,
     & climsst_lat0, climsst_lat_inc,
     & climsst_nlon, climsst_nlat,
     & climsss_lon0, climsss_lon_inc,
     & climsss_lat0, climsss_lat_inc,
     & climsss_nlon, climsss_nlat
#endif

      _BEGIN_MASTER(mythid)

c     Set default values.

c     Calendar data.
      climtempstartdate1 = 0
      climtempstartdate2 = 0
      climtempperiod     = 0

      climsaltstartdate1 = 0
      climsaltstartdate2 = 0
      climsaltperiod     = 0

      climsststartdate1  = 0
      climsststartdate2  = 0
      climsstperiod      = 0

      climsssstartdate1  = 0
      climsssstartdate2  = 0
      climsssperiod      = 0

c     Data files.
      climtempfile       = ' '
      climsaltfile       = ' '
      climsstfile        = ' '
      climsssfile        = ' '

c     Start dates.
      climtempstartdate  = 0
      climsaltstartdate  = 0
      climsststartdate   = 0
      climsssstartdate   = 0

c     Initialise constant values for relax. to constant SST, SSS
      climsstconst = 0. _d 0
      climsssconst = 0. _d 0

c     Initialise freezing temperature of sea water
      climtempfreeze = -1.9 _d 0

c     Initialise file type and field precision
      exf_clim_iprec  = 32
      exf_clim_yftype = 'RL'

c     Check for the availability of the right calendar version.
      if ( calendarversion .ne. usescalendarversion ) then
         print*,' exf_Init: You are not using the appropriate'
         print*,'           version of the calendar package.'
         print*
         print*,' Please use Calendar version: ',
     &        usescalendarversion
         stop ' stopped in exf_Init.'
      endif

c     Next, read the forcing data file.
      call nml_filter( 'data.exf_clim', scrunit1, myThid )
      if (scrunit1 .eq. 0) then
         stop 'exf_clim_readparms: reading namelist failed'
      end if
      read(  scrunit1, nml = exf_clim_nml )
      close( scrunit1 )

c     Complete the start date specifications for the forcing
c     fields to get a complete calendar date array.

c     check for consistency

      if (.NOT. (exf_clim_iprec .EQ. 32
     &      .OR. exf_clim_iprec .EQ. 64)) then
      stop 'stopped in exf_clim_readparms: value of iprec not allowed'
      else if
     &   (.NOT. (exf_clim_yftype .EQ. 'RS'
     &      .OR. exf_clim_yftype .EQ. 'RL'))
     &          then
      stop 'stopped in exf_clim_readparms: value of yftype not allowed'
      end if           

#ifdef ALLOW_CLIMTEMP_RELAXATION
      if ( climtempfile .NE. ' ' ) then
         call cal_FullDate( climtempstartdate1, climtempstartdate2,
     &        date_array,                    mythid )
         call cal_TimePassed(modelstartdate,date_array,difftime,mythid)
         call cal_ToSeconds (difftime,      climtempstartdate  ,mythid)
         climtempstartdate=modelstart+climtempstartdate
      endif
#endif

#ifdef ALLOW_CLIMSALT_RELAXATION
      if ( climsaltfile .NE. ' ' ) then      
        call cal_FullDate( climsaltstartdate1, climsaltstartdate2,
     &                     date_array,                    mythid )
        call cal_TimePassed(modelstartdate,date_array,difftime,mythid)
        call cal_ToSeconds (difftime,      climsaltstartdate  ,mythid)
        climsaltstartdate=modelstart+climsaltstartdate
      endif
#endif

#ifdef ALLOW_CLIMSST_RELAXATION
      if ( climsstfile .NE. ' ' ) then
         call cal_FullDate( climsststartdate1, climsststartdate2,
     &        date_array,                  mythid )
         call cal_TimePassed(modelstartdate,date_array,difftime,mythid)
         call cal_ToSeconds (difftime,       climsststartdate  ,mythid)
         climsststartdate=modelstart+climsststartdate
      endif
#endif

#ifdef ALLOW_CLIMSSS_RELAXATION
      if ( climsssfile .NE. ' ' ) then
         call cal_FullDate( climsssstartdate1, climsssstartdate2,
     &        date_array,                  mythid )
         call cal_TimePassed(modelstartdate,date_array,difftime,mythid)
         call cal_ToSeconds (difftime,       climsssstartdate  ,mythid)
         climsssstartdate=modelstart+climsssstartdate
      endif
#endif

      _END_MASTER( mythid )

      _BARRIER

      end
1	heimbach	1.7	c $Header: /u/gcmpack/MITgcm/pkg/exf/exf_clim_readparms.F,v 1.6 2004/04/19 22:30:46 mlosch Exp $
2	heimbach	1.1
3	edhill	1.4	#include "EXF_OPTIONS.h"
4	heimbach	1.1
5
6			subroutine exf_clim_readparms(
7			I mythid
8			& )
9
10			c ==================================================================
11			c SUBROUTINE exf_clim_readparms
12			c ==================================================================
13			c
14			c o This routine initialises the climatologic forcing
15			c
16			c started: Ralf.Giering@FastOpt.de 25-Mai-20000
17			c
18			c ==================================================================
19			c SUBROUTINE exf_clim_readparms
20			c ==================================================================
21
22			implicit none
23
24			c == global variables ==
25
26			#include "EEPARAMS.h"
27			#include "SIZE.h"
28			#include "cal.h"
29			#include "exf.h"
30	dimitri	1.3	#include "exf_param.h"
31	heimbach	1.1	#include "exf_clim_param.h"
32
33			c == routine arguments ==
34
35			integer mythid
36
37			c == local variables ==
38
39			integer i
40	dimitri	1.5	integer date_array(4), difftime(4)
41	heimbach	1.1
42			c == end of interface ==
43
44			c Surface flux data.
45			namelist /exf_clim_nml/
46	mlosch	1.6	& climtempfreeze,
47	heimbach	1.1	& climtempstartdate1, climtempstartdate2, climtempperiod,
48			& climsaltstartdate1, climsaltstartdate2, climsaltperiod,
49	heimbach	1.2	& climsststartdate1, climsststartdate2, climsstperiod,
50			& climsssstartdate1, climsssstartdate2, climsssperiod,
51			& climtempfile, climsaltfile, climsstfile,
52			& climsssfile, climsstconst, climsssconst,
53	heimbach	1.1	& exf_clim_iprec, exf_clim_yftype
54	dimitri	1.3	#ifdef USE_EXF_INTERPOLATION
55			& ,climsst_lon0, climsst_lon_inc,
56			& climsst_lat0, climsst_lat_inc,
57			& climsst_nlon, climsst_nlat,
58			& climsss_lon0, climsss_lon_inc,
59			& climsss_lat0, climsss_lat_inc,
60			& climsss_nlon, climsss_nlat
61			#endif
62	heimbach	1.1
63			_BEGIN_MASTER(mythid)
64
65			c Set default values.
66
67			c Calendar data.
68			climtempstartdate1 = 0
69			climtempstartdate2 = 0
70			climtempperiod = 0
71
72			climsaltstartdate1 = 0
73			climsaltstartdate2 = 0
74			climsaltperiod = 0
75
76			climsststartdate1 = 0
77			climsststartdate2 = 0
78			climsstperiod = 0
79
80			climsssstartdate1 = 0
81			climsssstartdate2 = 0
82			climsssperiod = 0
83
84			c Data files.
85			climtempfile = ' '
86			climsaltfile = ' '
87			climsstfile = ' '
88			climsssfile = ' '
89
90	dimitri	1.5	c Start dates.
91			climtempstartdate = 0
92			climsaltstartdate = 0
93			climsststartdate = 0
94			climsssstartdate = 0
95	heimbach	1.2
96			c Initialise constant values for relax. to constant SST, SSS
97			climsstconst = 0. _d 0
98			climsssconst = 0. _d 0
99	mlosch	1.6
100			c Initialise freezing temperature of sea water
101			climtempfreeze = -1.9 _d 0
102	heimbach	1.1
103			c Initialise file type and field precision
104			exf_clim_iprec = 32
105			exf_clim_yftype = 'RL'
106
107			c Check for the availability of the right calendar version.
108			if ( calendarversion .ne. usescalendarversion ) then
109			print*,' exf_Init: You are not using the appropriate'
110			print*,' version of the calendar package.'
111			print*
112			print*,' Please use Calendar version: ',
113			& usescalendarversion
114			stop ' stopped in exf_Init.'
115			endif
116
117			c Next, read the forcing data file.
118			call nml_filter( 'data.exf_clim', scrunit1, myThid )
119			if (scrunit1 .eq. 0) then
120			stop 'exf_clim_readparms: reading namelist failed'
121			end if
122			read( scrunit1, nml = exf_clim_nml )
123			close( scrunit1 )
124
125			c Complete the start date specifications for the forcing
126			c fields to get a complete calendar date array.
127
128			c check for consistency
129
130			if (.NOT. (exf_clim_iprec .EQ. 32
131			& .OR. exf_clim_iprec .EQ. 64)) then
132			stop 'stopped in exf_clim_readparms: value of iprec not allowed'
133			else if
134			& (.NOT. (exf_clim_yftype .EQ. 'RS'
135			& .OR. exf_clim_yftype .EQ. 'RL'))
136			& then
137			stop 'stopped in exf_clim_readparms: value of yftype not allowed'
138			end if
139
140			#ifdef ALLOW_CLIMTEMP_RELAXATION
141	heimbach	1.7	if ( climtempfile .NE. ' ' ) then
142			call cal_FullDate( climtempstartdate1, climtempstartdate2,
143			& date_array, mythid )
144			call cal_TimePassed(modelstartdate,date_array,difftime,mythid)
145			call cal_ToSeconds (difftime, climtempstartdate ,mythid)
146			climtempstartdate=modelstart+climtempstartdate
147			endif
148	heimbach	1.1	#endif
149
150			#ifdef ALLOW_CLIMSALT_RELAXATION
151	heimbach	1.7	if ( climsaltfile .NE. ' ' ) then
152	heimbach	1.1	call cal_FullDate( climsaltstartdate1, climsaltstartdate2,
153	dimitri	1.5	& date_array, mythid )
154			call cal_TimePassed(modelstartdate,date_array,difftime,mythid)
155			call cal_ToSeconds (difftime, climsaltstartdate ,mythid)
156			climsaltstartdate=modelstart+climsaltstartdate
157	heimbach	1.7	endif
158	heimbach	1.1	#endif
159
160			#ifdef ALLOW_CLIMSST_RELAXATION
161	heimbach	1.7	if ( climsstfile .NE. ' ' ) then
162			call cal_FullDate( climsststartdate1, climsststartdate2,
163			& date_array, mythid )
164			call cal_TimePassed(modelstartdate,date_array,difftime,mythid)
165			call cal_ToSeconds (difftime, climsststartdate ,mythid)
166			climsststartdate=modelstart+climsststartdate
167			endif
168	heimbach	1.1	#endif
169
170			#ifdef ALLOW_CLIMSSS_RELAXATION
171	heimbach	1.7	if ( climsssfile .NE. ' ' ) then
172			call cal_FullDate( climsssstartdate1, climsssstartdate2,
173			& date_array, mythid )
174			call cal_TimePassed(modelstartdate,date_array,difftime,mythid)
175			call cal_ToSeconds (difftime, climsssstartdate ,mythid)
176			climsssstartdate=modelstart+climsssstartdate
177			endif
178	heimbach	1.1	#endif
179
180			_END_MASTER( mythid )
181
182			_BARRIER
183
184			end