C $Header: /u/gcmpack/MITgcm/pkg/exf/exf_readparms.F,v 1.50 2008/02/22 20:25:54 dimitri Exp $
C $Name: $
C $Header: /u/gcmpack/MITgcm_contrib/high_res_cube/code-mods/EXF_OPTIONS.h,v 1.3 2007/12/06 21:01:13 dimitri Exp $
C $Name: $
C $Header: /u/gcmpack/MITgcm/model/inc/CPP_OPTIONS.h,v 1.42 2007/11/28 00:18:16 dimitri Exp $
C $Name: $
C CPP flags controlling particular source code features
C o Shortwave heating as extra term in external_forcing.F
C Note: this should be a run-time option
C o Include/exclude phi_hyd calculation code
C o Include/exclude call to S/R CONVECT
C o Include/exclude call to S/R CALC_DIFFUSIVITY
C o Allow latitudinally varying BryanLewis79 vertical diffusivity
C o Allow full 3D specification of vertical diffusivity
C o Include/exclude Implicit vertical advection code
C o Include/exclude AdamsBashforth-3rd-Order code
C o Include/exclude nonHydrostatic code
C o Include pressure loading code
C o exclude/allow external forcing-fields load
C this allows to read & do simple linear time interpolation of oceanic
C forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
C o Use "Exact Convervation" of fluid in Free-Surface formulation
C so that d/dt(eta) is exactly equal to - Div.Transport
C o Allow the use of Non-Linear Free-Surface formulation
C this implies that surface thickness (hFactors) vary with time
C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
C using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
C *only for use on a lat-lon grid*
C Setting this flag here affects both momentum and tracer equation unless
C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
C The definition of the flag is commented to avoid interference with
C such other header files.
C The preferred method is specifying a value for viscAhGrid or viscA4Grid
C in data which is then automatically scaled by the grid size;
C the old method of specifying viscAh/viscA4 and this flag is provided
C for completeness only (and for use with the adjoint).
C#define ISOTROPIC_COS_SCALING
C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
C *only for use on a lat-lon grid*
C Has no effect if ISOTROPIC_COS_SCALING is undefined.
C Has no effect on vector invariant momentum equations.
C Setting this flag here affects both momentum and tracer equation unless
C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
C The definition of the flag is commented to avoid interference with
C such other header files.
C#define COSINEMETH_III
C o Use "OLD" UV discretisation near boundaries (*not* recommended)
C Note - only works with #undef NO_SLIP_LATERAL in calc_mom_rhs.F
C because the old code did not have no-slip BCs
C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
C is still useful with, e.g., single-domain curvilinear configurations.
C o Execution environment support options
C $Header: /u/gcmpack/MITgcm/eesupp/inc/CPP_EEOPTIONS.h,v 1.29 2008/01/08 23:57:55 jahn Exp $
C $Name: $
CBOP
C !ROUTINE: CPP_EEOPTIONS.h
C !INTERFACE:
C include "CPP_EEOPTIONS.h"
C
C !DESCRIPTION:
C *==========================================================*
C | CPP\_EEOPTIONS.h |
C *==========================================================*
C | C preprocessor "execution environment" supporting |
C | flags. Use this file to set flags controlling the |
C | execution environment in which a model runs - as opposed |
C | to the dynamical problem the model solves. |
C | Note: Many options are implemented with both compile time|
C | and run-time switches. This allows options to be |
C | removed altogether, made optional at run-time or |
C | to be permanently enabled. This convention helps |
C | with the data-dependence analysis performed by the |
C | adjoint model compiler. This data dependency |
C | analysis can be upset by runtime switches that it |
C | is unable to recoginise as being fixed for the |
C | duration of an integration. |
C | A reasonable way to use these flags is to |
C | set all options as selectable at runtime but then |
C | once an experimental configuration has been |
C | identified, rebuild the code with the appropriate |
C | options set at compile time. |
C *==========================================================*
CEOP
C In general the following convention applies:
C ALLOW - indicates an feature will be included but it may
C CAN have a run-time flag to allow it to be switched
C on and off.
C If ALLOW or CAN directives are "undef'd" this generally
C means that the feature will not be available i.e. it
C will not be included in the compiled code and so no
C run-time option to use the feature will be available.
C
C ALWAYS - indicates the choice will be fixed at compile time
C so no run-time option will be present
C-- Flag used to indicate whether Fortran formatted write
C and read are threadsafe. On SGI the routines can be thread
C safe, on Sun it is not possible - if you are unsure then
C undef this option.
C-- Flag used to indicate whether Binary write to Local file (i.e.,
C a different file for each tile) and read are thread-safe.
C-- Flag to turn off the writing of error message to ioUnit zero
C-- Flag turns off MPI_SEND ready_to_receive polling in the
C gather_* subroutines to speed up integrations.
C-- Control MPI based parallel processing
CXXX We no longer select the use of MPI via this file (CPP_EEOPTIONS.h)
CXXX To use MPI, use an appropriate genmake2 options file or use
CXXX genmake2 -mpi .
CXXX #undef ALLOW_USE_MPI
CXXX #undef ALWAYS_USE_MPI
C-- Control use of communication that might overlap computation.
C Under MPI selects/deselects "non-blocking" sends and receives.
C-- Control use of communication that is atomic to computation.
C Under MPI selects/deselects "blocking" sends and receives.
C-- Control use of JAM routines for Artic network
C These invoke optimized versions of "exchange" and "sum" that
C utilize the programmable aspect of Artic cards.
C-- Control storage of floating point operands
C On many systems it improves performance only to use
C 8-byte precision for time stepped variables.
C Constant in time terms ( geometric factors etc.. )
C can use 4-byte precision, reducing memory utilisation and
C boosting performance because of a smaller working
C set size. However, on vector CRAY systems this degrades
C performance.
C-- Control use of "double" precision constants.
C Use D0 where it means REAL*8 but not where it means REAL*16
C-- Control XY periodicity in processor to grid mappings
C Note: Model code does not need to know whether a domain is
C periodic because it has overlap regions for every box.
C Model assume that these values have been
C filled in some way.
C-- Alternative formulation of BYTESWAP, faster than
C compiler flag -byteswapio on the Altix.
C-- Alternative way of doing global sum without MPI allreduce call
C but instead, explicit MPI send & recv calls.
C-- Alternative way of doing global sum on a single CPU
C to eliminate tiling-dependent roundoff errors.
C Note: This is slow.
C $Header: /u/gcmpack/MITgcm/eesupp/inc/CPP_EEMACROS.h,v 1.15 2006/08/10 17:46:55 edhill Exp $
C $Name: $
CBOP
C !ROUTINE: CPP_EEMACROS.h
C !INTERFACE:
C include "CPP_EEMACROS.h "
C !DESCRIPTION:
C *==========================================================*
C | CPP_EEMACROS.h
C *==========================================================*
C | C preprocessor "execution environment" supporting
C | macros. Use this file to define macros for simplifying
C | execution environment in which a model runs - as opposed
C | to the dynamical problem the model solves.
C *==========================================================*
CEOP
C In general the following convention applies:
C ALLOW - indicates an feature will be included but it may
C CAN have a run-time flag to allow it to be switched
C on and off.
C If ALLOW or CAN directives are "undef'd" this generally
C means that the feature will not be available i.e. it
C will not be included in the compiled code and so no
C run-time option to use the feature will be available.
C
C ALWAYS - indicates the choice will be fixed at compile time
C so no run-time option will be present
C Flag used to indicate which flavour of multi-threading
C compiler directives to use. Only set one of these.
C USE_SOLARIS_THREADING - Takes directives for SUN Workshop
C compiler.
C USE_KAP_THREADING - Takes directives for Kuck and
C Associates multi-threading compiler
C ( used on Digital platforms ).
C USE_IRIX_THREADING - Takes directives for SGI MIPS
C Pro Fortran compiler.
C USE_EXEMPLAR_THREADING - Takes directives for HP SPP series
C compiler.
C USE_C90_THREADING - Takes directives for CRAY/SGI C90
C system F90 compiler.
C-- Define the mapping for the _BARRIER macro
C On some systems low-level hardware support can be accessed through
C compiler directives here.
C-- Define the mapping for the BEGIN_CRIT() and END_CRIT() macros.
C On some systems we simply execute this section only using the
C master thread i.e. its not really a critical section. We can
C do this because we do not use critical sections in any critical
C sections of our code!
C-- Define the mapping for the BEGIN_MASTER_SECTION() and
C END_MASTER_SECTION() macros. These are generally implemented by
C simply choosing a particular thread to be "the master" and have
C it alone execute the BEGIN_MASTER..., END_MASTER.. sections.
CcnhDebugStarts
C Alternate form to the above macros that increments (decrements) a counter each
C time a MASTER section is entered (exited). This counter can then be checked in barrier
C to try and detect calls to BARRIER within single threaded sections.
C Using these macros requires two changes to Makefile - these changes are written
C below.
C 1 - add a filter to the CPP command to kill off commented _MASTER lines
C 2 - add a filter to the CPP output the converts the string N EWLINE to an actual newline.
C The N EWLINE needs to be changes to have no space when this macro and Makefile changes
C are used. Its in here with a space to stop it getting parsed by the CPP stage in these
C comments.
C #define IF ( a .EQ. 1 ) THEN IF ( a .EQ. 1 ) THEN N EWLINE CALL BARRIER_MS(a)
C #define ENDIF CALL BARRIER_MU(a) N EWLINE ENDIF
C 'CPP = cat $< | $(TOOLSDIR)/set64bitConst.sh | grep -v '^[cC].*_MASTER' | cpp -traditional -P'
C .F.f:
C $(CPP) $(DEFINES) $(INCLUDES) | sed 's/N EWLINE/\n/' > $@
CcnhDebugEnds
C-- Control storage of floating point operands
C On many systems it improves performance only to use
C 8-byte precision for time stepped variables.
C Constant in time terms ( geometric factors etc.. )
C can use 4-byte precision, reducing memory utilisation and
C boosting performance because of a smaller working
C set size. However, on vector CRAY systems this degrades
C performance.
C-- Control use of JAM routines for Artic network
C These invoke optimized versions of "exchange" and "sum" that
C utilize the programmable aspect of Artic cards.
C-- Control use of "double" precision constants.
C Use d0 where it means REAL*8 but not where it means REAL*16
C-- Substitue for 1.D variables
C Sun compilers do not use 8-byte precision for literals
C unless .Dnn is specified. CRAY vector machines use 16-byte
C precision when they see .Dnn which runs very slowly!
C o Include/exclude code specific to the ECCO/SEALION version.
C AUTODIFF or EXF package.
C Currently controled by a single header file
C For this to work, PACKAGES_CONFIG.h needs to be included!
cph#if (defined (ALLOW_AUTODIFF) || cph defined (ALLOW_ECCO) || cph defined ())
cph# include "ECCO_CPPOPTIONS.h"
cph#endif
C CPP flags controlling which code is included in the files that
C will be compiled.
C
c pkg/exf CPP options:
c --------------------
c
c >>> EXF_VERBOSE <<<
c Do a bit more printout for the log file than usual.
c
c >>> ALLOW_ATM_WIND <<<
c If defined, 10-m wind fields can be read-in from files.
c
c >>> ALLOW_ATM_TEMP <<<
c If defined, atmospheric temperature and specific
c humidity fields can be read-in from files.
c
c >>> ALLOW_DOWNWARD_RADIATION <<<
c If defined, downward long-wave and short-wave radiation
c can be read-in form files or computed from lwflux and swflux.
c
c >>> ALLOW_BULKFORMULAE <<<
c Allows the use of bulk formulae in order to estimate
c turbulent and radiative fluxes at the ocean's surface.
c
c >>> EXF_READ_EVAP <<<
c If defined, evaporation fields are read-in, rather than
c computed from atmospheric state.
c
c >>> ALLOW_RUNOFF <<<
c If defined, river and glacier runoff can be read-in from files.
c
c >>> <<<
c If defined, atmospheric pressure can be read-in from files.
c WARNING: this flag is set (define/undef) in CPP_OPTIONS.h
c and cannot be changed here (in EXF_OPTIONS)
c
c >>> ALLOW_CLIMSST_RELAXATION <<<
c Allow the relaxation to a monthly climatology of sea surface
c temperature, e.g. the Reynolds climatology.
c
c >>> ALLOW_CLIMSSS_RELAXATION <<<
c Allow the relaxation to a monthly climatology of sea surface
c salinity, e.g. the Levitus climatology.
c
c >>> USE_EXF_INTERPOLATION <<<
c Allows specification of arbitrary Cartesian input grids.
c
c ====================================================================
c
c The following CPP options:
c
c ALLOW_ATM_WIND (WIND)
c ALLOW_ATM_TEMP (TEMP)
c ALLOW_DOWNWARD_RADIATION (DOWN)
c ALLOW_BULKFORMULAE (BULK)
c EXF_READ_EVAP (EVAP)
c
c permit the ocean-model forcing configurations listed in the
c table below. The first configuration is the default,
c flux-forced, ocean model. The next four are stand-alone
c configurations that use pkg/exf, open-water bulk formulae to
c compute the missing surface fluxes from atmospheric variables.
c The last four configurations can be used in conjunction with
c pkg/seaice to model ice-covered regions. The forcing fields
c in the rightmost column are defined in exf_fields.
c
c
c WIND |TEMP |DOWN |BULK |EVAP | actions
c -----|-----|-----|-----|-----|-------------------------------------
c | | | | |
c - | - | - | - | - | Read-in ustress, vstress, hflux,
c | | | | | swflux, and sflux.
c | | | | |
c def | def | def | def | - | Read-in uwind, vwind, atemp, aqh,
c | | | | | swdown, lwdown, precip, and runoff.
c | | | | | Compute ustress, vstress, hflux,
c | | | | | swflux, and sflux.
c | | | | |
c def | def | - | def | - | Read-in uwind, vwind, atemp, aqh,
c | | | | | swflux, lwflux, precip, and runoff.
c | | | | | Compute ustress, vstress, hflux,
c | | | | | and sflux.
c | | | | |
c def | - | - | def | - | Read-in uwind, vwind, hflux,
c | | | | | swflux, and sflux.
c | | | | | Compute ustress and vstress.
c | | | | |
c - | def | - | def | - | Read-in ustress, vstress, atemp,
c | | | | | aqh, swflux, lwflux, precip, and
c | | | | | runoff. Compute hflux and sflux.
c | | | | |
c def | def | - | - | def | Read-in uwind, vwind, atemp, aqh,
c | | | | | swflux, lwflux, precip, runoff,
c | | | | | and evap.
c | | | | |
c def | def | - | def | - | Read-in uwind, vwind, atemp, aqh,
c | | | | | swflux, lwflux, precip, and runoff.
c | | | | | Compute open-water ustress, vstress,
c | | | | | hflux, swflux, and evap.
c | | | | |
c def | def | def | - | def | Read-in uwind, vwind, atemp, aqh,
c | | | | | swdown, lwdown, precip, runoff,
c | | | | | and evap.
c | | | | |
c def | def | def | def | - | Read-in uwind, vwind, atemp, aqh,
c | | | | | swdown, lwdown, precip, and runoff.
c | | | | | Compute open-water ustress, vstress,
c | | | | | hflux, swflux, and evap.
c
c ====================================================================
C Do more printout for the protocol file than usual.
C Bulk formulae related flags.
C Relaxation to monthly climatologies.
C Use spatial interpolation to interpolate
C forcing files from input grid to model grid.
SUBROUTINE EXF_READPARMS( myThid )
c ==================================================================
c SUBROUTINE exf_readparms
c ==================================================================
c
c o This routine initialises the package that calculates external
c forcing fields for a given timestep of the MITgcmUV. Parameters
c for this package are set in "data.externalforcing". Some additional
c precompiler switches have to be specified in "EXF_OPTIONS.h".
c
c started: Christian Eckert eckert@mit.edu 30-Jun-1999
c
c changed: Christian Eckert eckert@mit.edu 11-Jan-2000
c - Restructured the code in order to create a package
c for the MITgcmUV.
c Christian Eckert eckert@mit.edu 12-Feb-2000
c - Changed Routine names (package prefix: exf_)
c changed: Patrick Heimbach, heimbach@mit.edu 04-May-2000
c - changed the handling of precip and sflux with respect
c to CPP options and
c changed: Ralf.Giering@FastOpt.de 25-Mai-20000
c - moved relaxation and climatology to extra routines
c Patrick Heimbach, heimbach@mit.edu 04-May-2000
c - added obcs parameters
c changed: Virginie Thierry, vthierry@ucsd.edu 04-June-2001
c - added new obcs parameters (for each boundaries)
c included runoff D. Stammer, Nov. 25, 2001
c included pressure forcing. heimbach@mit.edu 05-Nov-2002
c added "repeatPeriod" for cycling of forcing datasets 19-Dec-2002
c mods for pkg/seaice: menemenlis@jpl.nasa.gov 20-Dec-2002
c
c ==================================================================
c SUBROUTINE exf_readparms
c ==================================================================
implicit none
c == global variables ==
C $Header: /u/gcmpack/MITgcm/eesupp/inc/EEPARAMS.h,v 1.23 2006/07/30 00:00:59 jmc Exp $
C $Name: $
CBOP
C !ROUTINE: EEPARAMS.h
C !INTERFACE:
C include "EEPARAMS.h"
C
C !DESCRIPTION:
C *==========================================================*
C | EEPARAMS.h |
C *==========================================================*
C | Parameters for "execution environemnt". These are used |
C | by both the particular numerical model and the execution |
C | environment support routines. |
C *==========================================================*
CEOP
C ======== EESIZE.h ========================================
C MAX_LEN_MBUF - Default message buffer max. size
C MAX_LEN_FNAM - Default file name max. size
C MAX_LEN_PREC - Default rec len for reading "parameter" files
INTEGER MAX_LEN_MBUF
PARAMETER ( MAX_LEN_MBUF = 512 )
INTEGER MAX_LEN_FNAM
PARAMETER ( MAX_LEN_FNAM = 512 )
INTEGER MAX_LEN_PREC
PARAMETER ( MAX_LEN_PREC = 200 )
C MAX_NO_THREADS - Maximum number of threads allowed.
C MAX_NO_PROCS - Maximum number of processes allowed.
C MAX_NO_BARRIERS - Maximum number of distinct thread "barriers"
INTEGER MAX_NO_THREADS
PARAMETER ( MAX_NO_THREADS = 4 )
INTEGER MAX_NO_PROCS
PARAMETER ( MAX_NO_PROCS = 2048 )
INTEGER MAX_NO_BARRIERS
PARAMETER ( MAX_NO_BARRIERS = 1 )
C Particularly weird and obscure voodoo numbers
C lShare - This wants to be the length in
C [148]-byte words of the size of
C the address "window" that is snooped
C on an SMP bus. By separating elements in
C the global sum buffer we can avoid generating
C extraneous invalidate traffic between
C processors. The length of this window is usually
C a cache line i.e. small O(64 bytes).
C The buffer arrays are usually short arrays
C and are declared REAL ARRA(lShare[148],LBUFF).
C Setting lShare[148] to 1 is like making these arrays
C one dimensional.
INTEGER cacheLineSize
INTEGER lShare1
INTEGER lShare4
INTEGER lShare8
PARAMETER ( cacheLineSize = 256 )
PARAMETER ( lShare1 = cacheLineSize )
PARAMETER ( lShare4 = cacheLineSize/4 )
PARAMETER ( lShare8 = cacheLineSize/8 )
INTEGER MAX_VGS
PARAMETER ( MAX_VGS = 8192 )
C ======== EESIZE.h ========================================
C SQUEEZE_RIGHT - Flag indicating right blank space removal
C from text field.
C SQUEEZE_LEFT - Flag indicating left blank space removal
C from text field.
C SQUEEZE_BOTH - Flag indicating left and right blank
C space removal from text field.
C PRINT_MAP_XY - Flag indicating to plot map as XY slices
C PRINT_MAP_XZ - Flag indicating to plot map as XZ slices
C PRINT_MAP_YZ - Flag indicating to plot map as YZ slices
C commentCharacter - Variable used in column 1 of parameter
C files to indicate comments.
C INDEX_I - Variable used to select an index label
C INDEX_J for formatted input parameters.
C INDEX_K
C INDEX_NONE
CHARACTER*(*) SQUEEZE_RIGHT
PARAMETER ( SQUEEZE_RIGHT = 'R' )
CHARACTER*(*) SQUEEZE_LEFT
PARAMETER ( SQUEEZE_LEFT = 'L' )
CHARACTER*(*) SQUEEZE_BOTH
PARAMETER ( SQUEEZE_BOTH = 'B' )
CHARACTER*(*) PRINT_MAP_XY
PARAMETER ( PRINT_MAP_XY = 'XY' )
CHARACTER*(*) PRINT_MAP_XZ
PARAMETER ( PRINT_MAP_XZ = 'XZ' )
CHARACTER*(*) PRINT_MAP_YZ
PARAMETER ( PRINT_MAP_YZ = 'YZ' )
CHARACTER*(*) commentCharacter
PARAMETER ( commentCharacter = '#' )
INTEGER INDEX_I
INTEGER INDEX_J
INTEGER INDEX_K
INTEGER INDEX_NONE
PARAMETER ( INDEX_I = 1,
& INDEX_J = 2,
& INDEX_K = 3,
& INDEX_NONE = 4 )
C EXCH_IGNORE_CORNERS - Flag to select ignoring or
C EXCH_UPDATE_CORNERS updating of corners during
C an edge exchange.
INTEGER EXCH_IGNORE_CORNERS
INTEGER EXCH_UPDATE_CORNERS
PARAMETER ( EXCH_IGNORE_CORNERS = 0,
& EXCH_UPDATE_CORNERS = 1 )
C FORWARD_SIMULATION
C REVERSE_SIMULATION
C TANGENT_SIMULATION
INTEGER FORWARD_SIMULATION
INTEGER REVERSE_SIMULATION
INTEGER TANGENT_SIMULATION
PARAMETER ( FORWARD_SIMULATION = 0,
& REVERSE_SIMULATION = 1,
& TANGENT_SIMULATION = 2 )
C-- COMMON /EEPARAMS_L/ Execution environment public logical variables.
C eeBootError - Flag indicating error during multi-processing
C eeEndError initialisation/termination.
C fatalError - Flag used to indicate that the model is ended with
C an error
C useCoupler - use Coupler for a multi-components set-up
COMMON /EEPARAMS_L/ eeBootError, fatalError, eeEndError,
& useCubedSphereExchange, useCoupler, useSETRLSTK, useSIGREG
LOGICAL eeBootError
LOGICAL eeEndError
LOGICAL fatalError
LOGICAL useCubedSphereExchange
LOGICAL useCoupler
LOGICAL useSETRLSTK
LOGICAL useSIGREG
C-- COMMON /EPARAMS_I/ Execution environment public integer variables.
C errorMessageUnit - Fortran IO unit for error messages
C standardMessageUnit - Fortran IO unit for informational messages
C scrUnit1 - Scratch file 1 unit number
C scrUnit2 - Scratch file 2 unit number
C eeDataUnit - Unit number used for reading "execution environment" parameter file.
C modelDataUnit - Unit number for reading "model" parameter file.
C numberOfProcs - Number of processes computing in parallel
C pidIO - Id of process to use for I/O.
C myBxLo, myBxHi - Extents of domain in blocks in X and Y
C myByLo, myByHi that each threads is responsble for.
C myProcId - My own "process" id.
C myPx - My X coord on the proc. grid.
C myPy - My Y coord on the proc. grid.
C myXGlobalLo - My bottom-left (south-west) x-index
C global domain. The x-coordinate of this
C point in for example m or degrees is *not*
C specified here. A model needs to provide a
C mechanism for deducing that information if it
C is needed.
C myYGlobalLo - My bottom-left (south-west) y-index in
C global domain. The y-coordinate of this
C point in for example m or degrees is *not*
C specified here. A model needs to provide a
C mechanism for deducing that information if it
C is needed.
C nThreads - No. of threads
C nTx - No. of threads in X
C nTy - No. of threads in Y
C This assumes a simple cartesian
C gridding of the threads which is not required elsewhere
C but that makes it easier.
C ioErrorCount - IO Error Counter. Set to zero initially and increased
C by one every time an IO error occurs.
COMMON /EEPARAMS_I/ errorMessageUnit, standardMessageUnit,
& scrUnit1, scrUnit2, eeDataUnit, modelDataUnit,
& numberOfProcs, pidIO, myProcId,
& myPx, myPy, myXGlobalLo, myYGlobalLo, nThreads,
& myBxLo, myBxHi, myByLo, myByHi,
& nTx, nTy, ioErrorCount
INTEGER eeDataUnit
INTEGER errorMessageUnit
INTEGER ioErrorCount(MAX_NO_THREADS)
INTEGER modelDataUnit
INTEGER myBxLo(MAX_NO_THREADS)
INTEGER myBxHi(MAX_NO_THREADS)
INTEGER myByLo(MAX_NO_THREADS)
INTEGER myByHi(MAX_NO_THREADS)
INTEGER myProcId
INTEGER myPx
INTEGER myPy
INTEGER myXGlobalLo
INTEGER myYGlobalLo
INTEGER nThreads
INTEGER nTx
INTEGER nTy
INTEGER numberOfProcs
INTEGER pidIO
INTEGER scrUnit1
INTEGER scrUnit2
INTEGER standardMessageUnit
CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
C $Header: /u/gcmpack/MITgcm/model/inc/SIZE.h,v 1.27 2005/09/19 18:42:35 baylor Exp $
C $Name: $
C
CBOP
C !ROUTINE: SIZE.h
C !INTERFACE:
C include SIZE.h
C !DESCRIPTION: \bv
C *==========================================================*
C | SIZE.h Declare size of underlying computational grid.
C *==========================================================*
C | The design here support a three-dimensional model grid
C | with indices I,J and K. The three-dimensional domain
C | is comprised of nPx*nSx blocks of size sNx along one axis
C | nPy*nSy blocks of size sNy along another axis and one
C | block of size Nz along the final axis.
C | Blocks have overlap regions of size OLx and OLy along the
C | dimensions that are subdivided.
C *==========================================================*
C \ev
CEOP
C Voodoo numbers controlling data layout.
C sNx :: No. X points in sub-grid.
C sNy :: No. Y points in sub-grid.
C OLx :: Overlap extent in X.
C OLy :: Overlat extent in Y.
C nSx :: No. sub-grids in X.
C nSy :: No. sub-grids in Y.
C nPx :: No. of processes to use in X.
C nPy :: No. of processes to use in Y.
C Nx :: No. points in X for the total domain.
C Ny :: No. points in Y for the total domain.
C Nr :: No. points in Z for full process domain.
INTEGER sNx
INTEGER sNy
INTEGER OLx
INTEGER OLy
INTEGER nSx
INTEGER nSy
INTEGER nPx
INTEGER nPy
INTEGER Nx
INTEGER Ny
INTEGER Nr
PARAMETER (
& sNx = 70,
& sNy = 64,
& OLx = 5,
& OLy = 5,
& nSx = 1,
& nSy = 1,
& nPx = 1,
& nPy = 1,
& Nx = sNx*nSx*nPx,
& Ny = sNy*nSy*nPy,
& Nr = 50)
C MAX_OLX - Set to the maximum overlap region size of any array
C MAX_OLY that will be exchanged. Controls the sizing of exch
C routine buufers.
INTEGER MAX_OLX
INTEGER MAX_OLY
PARAMETER ( MAX_OLX = OLx,
& MAX_OLY = OLy )
C $Header: /u/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.216 2008/04/05 18:09:30 jmc Exp $
C $Name: $
C
CBOP
C !ROUTINE: PARAMS.h
C !INTERFACE:
C #include PARAMS.h
C !DESCRIPTION:
C Header file defining model "parameters". The values from the
C model standard input file are stored into the variables held
C here. Notes describing the parameters can also be found here.
CEOP
C Macros for special grid options
C $Header: /u/gcmpack/MITgcm/model/inc/PARAMS_MACROS.h,v 1.3 2001/09/21 15:13:31 cnh Exp $
C $Name: $
C
CBOP
C !ROUTINE: PARAMS_MACROS.h
C !INTERFACE:
C include PARAMS_MACROS.h
C !DESCRIPTION: \bv
C *==========================================================*
C | PARAMS_MACROS.h
C *==========================================================*
C | These macros are used to substitute definitions for
C | PARAMS.h variables for particular configurations.
C | In setting these variables the following convention
C | applies.
C | define phi_CONST - Indicates the variable phi is fixed
C | in X, Y and Z.
C | define phi_FX - Indicates the variable phi only
C | varies in X (i.e.not in X or Z).
C | define phi_FY - Indicates the variable phi only
C | varies in Y (i.e.not in X or Z).
C | define phi_FXY - Indicates the variable phi only
C | varies in X and Y ( i.e. not Z).
C *==========================================================*
C \ev
CEOP
C $Header: /u/gcmpack/MITgcm/model/inc/FCORI_MACROS.h,v 1.4 2001/09/21 15:13:31 cnh Exp $
C $Name: $
C
CBOP
C !ROUTINE: FCORI_MACROS.h
C !INTERFACE:
C include FCORI_MACROS.h
C !DESCRIPTION: \bv
C *==========================================================*
C | FCORI_MACROS.h
C *==========================================================*
C | These macros are used to reduce memory requirement and/or
C | memory references when variables are fixed along a given
C | axis or axes.
C *==========================================================*
C \ev
CEOP
C-- Contants
C Useful physical values
Real*8 PI
PARAMETER ( PI = 3.14159265358979323844d0 )
Real*8 deg2rad
PARAMETER ( deg2rad = 2.d0*PI/360.d0 )
C Symbolic values
C precXXXX :: Used to indicate what precision to use for
C dumping model state.
INTEGER precFloat32
PARAMETER ( precFloat32 = 32 )
INTEGER precFloat64
PARAMETER ( precFloat64 = 64 )
C UNSET_xxx :: Used to indicate variables that have not been given a value
Real*8 UNSET_FLOAT8
PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
Real*4 UNSET_FLOAT4
PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
Real*8 UNSET_RL
PARAMETER ( UNSET_RL = 1.234567D5 )
Real*8 UNSET_RS
PARAMETER ( UNSET_RS = 1.234567E5 )
INTEGER UNSET_I
PARAMETER ( UNSET_I = 123456789 )
C-- COMMON /PARM_C/ Character valued parameters used by the model.
C buoyancyRelation :: Flag used to indicate which relation to use to
C get buoyancy.
C eosType :: choose the equation of state:
C LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
C pickupSuff :: force to start from pickup files (even if nIter0=0)
C and read pickup files with this suffix (max 10 Char.)
C mdsioLocalDir :: read-write tiled file from/to this directory name
C (+ 4 digits Processor-Rank) instead of current dir.
C tRefFile :: File containing reference Potential Temperat. tRef (1.D)
C sRefFile :: File containing reference salinity/spec.humid. sRef (1.D)
C rhoRefFile :: File containing reference density profile rhoRef (1.D)
C delRFile :: File containing vertical grid spacing delR (1.D array)
C delRcFile :: File containing vertical grid spacing delRc (1.D array)
C delXFile :: File containing X-spacing grid definition (1.D array)
C delYFile :: File containing Y-spacing grid definition (1.D array)
C horizGridFile :: File containing horizontal-grid definition
C (only when using curvilinear_grid)
C bathyFile :: File containing bathymetry. If not defined bathymetry
C is taken from inline function.
C topoFile :: File containing the topography of the surface (unit=m)
C (mainly used for the atmosphere = ground height).
C shelfIceFile :: File containing the topography of the shelfice draught
C (unit=m)
C hydrogThetaFile :: File containing initial hydrographic data (3-D)
C for potential temperature.
C hydrogSaltFile :: File containing initial hydrographic data (3-D)
C for salinity.
C diffKrFile :: File containing 3D specification of vertical diffusivity
C zonalWindFile :: File containing zonal wind data
C meridWindFile :: File containing meridional wind data
C thetaClimFile :: File containing surface theta climataology used
C in relaxation term -lambda(theta-theta*)
C saltClimFile :: File containing surface salt climataology used
C in relaxation term -lambda(salt-salt*)
C surfQfile :: File containing surface heat flux, excluding SW
C (old version, kept for backward compatibility)
C surfQnetFile :: File containing surface net heat flux
C surfQswFile :: File containing surface shortwave radiation
C dQdTfile :: File containing thermal relaxation coefficient
C EmPmRfile :: File containing surface fresh water flux
C NOTE: for backward compatibility EmPmRfile is specified in
C m/s when using external_fields_load.F. It is converted
C to kg/m2/s by multiplying by rhoConstFresh.
C saltFluxFile :: File containing surface salt flux
C pLoadFile :: File containing pressure loading
C eddyTauxFile :: File containing zonal Eddy stress data
C eddyTauyFile :: File containing meridional Eddy stress data
C the_run_name :: string identifying the name of the model "run"
COMMON /PARM_C/
& buoyancyRelation, eosType,
& pickupSuff, mdsioLocalDir,
& tRefFile, sRefFile, rhoRefFile,
& delRFile, delRcFile,
& delXFile, delYFile, horizGridFile,
& bathyFile, topoFile, shelfIceFile,
& hydrogThetaFile, hydrogSaltFile, diffKrFile,
& zonalWindFile, meridWindFile, thetaClimFile,
& saltClimFile,
& EmPmRfile, saltFluxFile,
& surfQfile, surfQnetFile, surfQswFile,
& lambdaThetaFile, lambdaSaltFile,
& uVelInitFile, vVelInitFile, pSurfInitFile,
& dQdTfile, ploadFile,
& eddyTauxFile, eddyTauyFile,
& the_run_name
CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
CHARACTER*(6) eosType
CHARACTER*(10) pickupSuff
CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
CHARACTER*(MAX_LEN_FNAM) tRefFile
CHARACTER*(MAX_LEN_FNAM) sRefFile
CHARACTER*(MAX_LEN_FNAM) rhoRefFile
CHARACTER*(MAX_LEN_FNAM) delRFile
CHARACTER*(MAX_LEN_FNAM) delRcFile
CHARACTER*(MAX_LEN_FNAM) delXFile
CHARACTER*(MAX_LEN_FNAM) delYFile
CHARACTER*(MAX_LEN_FNAM) horizGridFile
CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile
CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
CHARACTER*(MAX_LEN_FNAM) diffKrFile
CHARACTER*(MAX_LEN_FNAM) zonalWindFile
CHARACTER*(MAX_LEN_FNAM) meridWindFile
CHARACTER*(MAX_LEN_FNAM) thetaClimFile
CHARACTER*(MAX_LEN_FNAM) saltClimFile
CHARACTER*(MAX_LEN_FNAM) surfQfile
CHARACTER*(MAX_LEN_FNAM) surfQnetFile
CHARACTER*(MAX_LEN_FNAM) surfQswFile
CHARACTER*(MAX_LEN_FNAM) EmPmRfile
CHARACTER*(MAX_LEN_FNAM) saltFluxFile
CHARACTER*(MAX_LEN_FNAM) uVelInitFile
CHARACTER*(MAX_LEN_FNAM) vVelInitFile
CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
CHARACTER*(MAX_LEN_FNAM) dQdTfile
CHARACTER*(MAX_LEN_FNAM) ploadFile
CHARACTER*(MAX_LEN_FNAM) eddyTauxFile
CHARACTER*(MAX_LEN_FNAM) eddyTauyFile
CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
CHARACTER*(MAX_LEN_PREC/2) the_run_name
C-- COMMON /PARM_I/ Integer valued parameters used by the model.
C cg2dMaxIters :: Maximum number of iterations in the
C two-dimensional con. grad solver.
C cg2dChkResFreq :: Frequency with which to check residual
C in con. grad solver.
C cg2dPreCondFreq :: Frequency for updating cg2d preconditioner
C (non-linear free-surf.)
C cg3dMaxIters :: Maximum number of iterations in the
C three-dimensional con. grad solver.
C cg3dChkResFreq :: Frequency with which to check residual
C in con. grad solver.
C nIter0 :: Start time-step number of for this run
C nTimeSteps :: Number of timesteps to execute
C writeStatePrec :: Precision used for writing model state.
C writeBinaryPrec :: Precision used for writing binary files
C readBinaryPrec :: Precision used for reading binary files
C nonlinFreeSurf :: option related to non-linear free surface
C =0 Linear free surface ; >0 Non-linear
C select_rStar :: option related to r* vertical coordinate
C =0 (default) use r coord. ; > 0 use r*
C momForcingOutAB :: =1: take momentum forcing contribution
C out of (=0: in) Adams-Bashforth time stepping.
C tracForcingOutAB :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
C out of (=0: in) Adams-Bashforth time stepping.
C tempAdvScheme :: Temp. Horiz.Advection scheme selector
C tempVertAdvScheme :: Temp. Vert. Advection scheme selector
C saltAdvScheme :: Salt. Horiz.advection scheme selector
C saltVertAdvScheme :: Salt. Vert. Advection scheme selector
C selectKEscheme :: Kinetic Energy scheme selector (Vector Inv.)
C selectVortScheme :: Scheme selector for Vorticity term (Vector Inv.)
C monitorSelect :: select group of variables to monitor
C =1 : dynvars ; =2 : + vort ; =3 : + surface
C debugLevel :: debug level selector: higher -> more writing
COMMON /PARM_I/
& cg2dMaxIters,
& cg2dChkResFreq, cg2dPreCondFreq,
& cg3dMaxIters,
& cg3dChkResFreq,
& nIter0, nTimeSteps, nEndIter,
& writeStatePrec,
& writeBinaryPrec, readBinaryPrec,
& nonlinFreeSurf, select_rStar,
& momForcingOutAB, tracForcingOutAB,
& tempAdvScheme, tempVertAdvScheme,
& saltAdvScheme, saltVertAdvScheme,
& selectKEscheme, selectVortScheme,
& monitorSelect, debugLevel
INTEGER cg2dMaxIters
INTEGER cg2dChkResFreq
INTEGER cg2dPreCondFreq
INTEGER cg3dMaxIters
INTEGER cg3dChkResFreq
INTEGER nIter0
INTEGER nTimeSteps
INTEGER nEndIter
INTEGER writeStatePrec
INTEGER writeBinaryPrec
INTEGER readBinaryPrec
INTEGER nonlinFreeSurf
INTEGER select_rStar
INTEGER momForcingOutAB, tracForcingOutAB
INTEGER tempAdvScheme, tempVertAdvScheme
INTEGER saltAdvScheme, saltVertAdvScheme
INTEGER selectKEscheme
INTEGER selectVortScheme
INTEGER monitorSelect
INTEGER debugLevel
C
INTEGER debLevZero
PARAMETER(debLevZero=0)
INTEGER debLevA
PARAMETER(debLevA=1)
INTEGER debLevB
PARAMETER(debLevB=2)
C-- COMMON /PARM_L/ Logical valued parameters used by the model.
C- Coordinate + Grid params:
C fluidIsAir :: Set to indicate that the fluid major constituent
C is air
C fluidIsWater :: Set to indicate that the fluid major constituent
C is water
C usingPCoords :: Set to indicate that we are working in a pressure
C type coordinate (p or p*).
C usingZCoords :: Set to indicate that we are working in a height
C type coordinate (z or z*)
C useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
C this requires specific code for restart & exchange
C usingCartesianGrid :: If TRUE grid generation will be in a cartesian
C coordinate frame.
C usingSphericalPolarGrid :: If TRUE grid generation will be in a
C spherical polar frame.
C rotateGrid :: rotate grid coordinates to geographical coordinates
C according to Euler angles phiEuler, thetaEuler, psiEuler
C usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
C usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
C deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
C setInterFDr :: set Interface depth (put cell-Center at the middle)
C setCenterDr :: set cell-Center depth (put Interface at the middle)
C- Momentum params:
C no_slip_sides :: Impose "no-slip" at lateral boundaries.
C no_slip_bottom :: Impose "no-slip" at bottom boundary.
C useFullLeith :: Set to true to use full Leith viscosity(may be unstable
C on irregular grids)
C useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
C useAreaViscLength :: Set to true to use old scaling for viscous lengths,
C e.g., L2=Raz. May be preferable for cube sphere.
C momViscosity :: Flag which turns momentum friction terms on and off.
C momAdvection :: Flag which turns advection of momentum on and off.
C momForcing :: Flag which turns external forcing of momentum on
C and off.
C momPressureForcing :: Flag which turns pressure term in momentum equation
C on and off.
C metricTerms :: Flag which turns metric terms on or off.
C useNHMTerms :: If TRUE use non-hydrostatic metric terms.
C useCoriolis :: Flag which turns the coriolis terms on and off.
C use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
C useConstantF :: Coriolis parameter set to f0
C useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
C useSphereF :: Coriolis parameter set to 2.omega.sin(phi)
C useCDscheme :: use CD-scheme to calculate Coriolis terms.
C vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
C (default = F = use mom_fluxform package)
C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986)
C useJamartMomAdv :: Use wet-point method for V.I. non-linear term
C upwindVorticity :: bias interpolation of vorticity in the Coriolis term
C highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
C useAbsVorticity :: work with f+zeta in Coriolis terms
C upwindShear :: use 1rst order upwind interp. (V.I., vertical advection)
C momStepping :: Turns momentum equation time-stepping off
C- Temp. & Salt params:
C tempStepping :: Turns temperature equation time-stepping off
C saltStepping :: Turns salinity equation time-stepping off
C tempAdvection :: Flag which turns advection of temperature on and off.
C tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
C tempForcing :: Flag which turns external forcing of temperature on
C and off.
C saltAdvection :: Flag which turns advection of salinity on and off.
C saltIsActiveTr :: Salinity is a dynamically active tracer
C saltForcing :: Flag which turns external forcing of salinity on
C and off.
C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
C as a real Fresh Water (=> changes the Sea Level)
C if F, converts P+R-E to salt flux (no SL effect)
C- Time-stepping params:
C rigidLid :: Set to true to use rigid lid
C implicitFreeSurface :: Set to true to use implicit free surface
C exactConserv :: Set to true to conserve exactly the total Volume
C linFSConserveTr :: Set to true to correct source/sink of tracer
C at the surface due to Linear Free Surface
C uniformLin_PhiSurf :: Set to true to use a uniform Bo_surf in the
C linear relation Phi_surf = Bo_surf*eta
C quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
C nonHydrostatic :: Using non-hydrostatic algorithm
C use3Dsolver :: set to true to use 3-D pressure solver
C implicitIntGravWave :: treat Internal Gravity Wave implicitly
C staggerTimeStep :: enable a Stagger time stepping U,V (& W) then T,S
C implicitDiffusion :: Turns implicit vertical diffusion on
C implicitViscosity :: Turns implicit vertical viscosity on
C tempImplVertAdv :: Turns on implicit vertical advection for Temperature
C saltImplVertAdv :: Turns on implicit vertical advection for Salinity
C momImplVertAdv :: Turns on implicit vertical advection for Momentum
C multiDimAdvection :: Flag that enable multi-dimension advection
C useMultiDimAdvec :: True if multi-dim advection is used at least once
C momDissip_In_AB :: if False, put Dissipation tendency contribution
C out off Adams-Bashforth time stepping.
C doAB_onGtGs :: if the Adams-Bashforth time stepping is used, always
C apply AB on tracer tendencies (rather than on Tracer)
C- Other forcing params -
C balanceEmPmR :: substract global mean of EmPmR at every time step
C balanceQnet :: substract global mean of Qnet at every time step
C balancePrintMean:: print substracted global means to STDOUT
C doThetaClimRelax :: Set true if relaxation to temperature
C climatology is required.
C doSaltClimRelax :: Set true if relaxation to salinity
C climatology is required.
C allowFreezing :: Allows surface water to freeze and form ice
C useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
C periodicExternalForcing :: Set true if forcing is time-dependant
C- I/O parameters -
C globalFiles :: Selects between "global" and "tiled" files
C useSingleCpuIO :: On SGI platforms, option globalFiles is either
C slow (f77) or does not work (f90). When
C useSingleCpuIO is set, mdsio_writefield.F
C outputs from master mpi process only.
C pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
C startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
C usePickupBeforeC54 :: start from old-pickup files, generated with code from
C before checkpoint-54a, Jul 06, 2004.
C pickup_write_mdsio :: use mdsio to write pickups
C pickup_read_mdsio :: use mdsio to read pickups
C pickup_write_immed :: echo the pickup immediately (for conversion)
C writePickupAtEnd :: write pickup at the last timestep
C timeave_mdsio :: use mdsio for timeave output
C snapshot_mdsio :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
C monitor_stdio :: use stdio for monitor output
C dumpInitAndLast :: dumps model state to files at Initial (nIter0)
C & Last iteration, in addition multiple of dumpFreq iter.
COMMON /PARM_L/
& fluidIsAir, fluidIsWater,
& usingPCoords, usingZCoords, useDynP_inEos_Zc,
& usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
& usingCurvilinearGrid, usingCylindricalGrid,
& deepAtmosphere, setInterFDr, setCenterDr,
& no_slip_sides, no_slip_bottom,
& useFullLeith, useStrainTensionVisc, useAreaViscLength,
& momViscosity, momAdvection, momForcing,
& momPressureForcing, metricTerms, useNHMTerms,
& useCoriolis, use3dCoriolis,
& useConstantF, useBetaPlaneF, useSphereF,
& useCDscheme, vectorInvariantMomentum,
& useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
& upwindVorticity, highOrderVorticity,
& useAbsVorticity, upwindShear,
& momStepping, tempStepping, saltStepping,
& tempAdvection, tempIsActiveTr, tempForcing,
& saltAdvection, saltIsActiveTr, saltForcing,
& useRealFreshWaterFlux,
& rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
& uniformLin_PhiSurf,
& quasiHydrostatic, nonHydrostatic,
& use3Dsolver, implicitIntGravWave, staggerTimeStep,
& implicitDiffusion, implicitViscosity,
& tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
& multiDimAdvection, useMultiDimAdvec,
& momDissip_In_AB, doAB_onGtGs,
& balanceEmPmR, balanceQnet, balancePrintMean,
& doThetaClimRelax, doSaltClimRelax,
& allowFreezing, useOldFreezing,
& periodicExternalForcing,
& globalFiles, useSingleCpuIO,
& pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
& pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
& writePickupAtEnd,
& timeave_mdsio, snapshot_mdsio, monitor_stdio,
& outputTypesInclusive, dumpInitAndLast, debugMode,
& inAdMode, inAdTrue, inAdFalse, inAdExact
LOGICAL fluidIsAir
LOGICAL fluidIsWater
LOGICAL usingPCoords
LOGICAL usingZCoords
LOGICAL useDynP_inEos_Zc
LOGICAL usingCartesianGrid
LOGICAL usingSphericalPolarGrid, rotateGrid
LOGICAL usingCylindricalGrid
LOGICAL usingCurvilinearGrid
LOGICAL deepAtmosphere
LOGICAL setInterFDr
LOGICAL setCenterDr
LOGICAL useNHMTerms
LOGICAL no_slip_sides
LOGICAL no_slip_bottom
LOGICAL momViscosity
LOGICAL momAdvection
LOGICAL momForcing
LOGICAL momPressureForcing
LOGICAL useCoriolis
LOGICAL vectorInvariantMomentum
LOGICAL tempAdvection
LOGICAL tempIsActiveTr
LOGICAL tempForcing
LOGICAL saltAdvection
LOGICAL saltIsActiveTr
LOGICAL saltForcing
LOGICAL useRealFreshWaterFlux
LOGICAL useFullLeith
LOGICAL useStrainTensionVisc
LOGICAL useAreaViscLength
LOGICAL rigidLid
LOGICAL implicitFreeSurface
LOGICAL exactConserv
LOGICAL linFSConserveTr
LOGICAL uniformLin_PhiSurf
LOGICAL quasiHydrostatic
LOGICAL nonHydrostatic
LOGICAL use3Dsolver
LOGICAL implicitIntGravWave
LOGICAL staggerTimeStep
LOGICAL momStepping
LOGICAL tempStepping
LOGICAL saltStepping
LOGICAL metricTerms
LOGICAL useConstantF
LOGICAL useBetaPlaneF
LOGICAL useSphereF
LOGICAL use3dCoriolis
LOGICAL useCDscheme
LOGICAL useEnergyConservingCoriolis
LOGICAL useJamartWetPoints
LOGICAL useJamartMomAdv
LOGICAL upwindVorticity
LOGICAL highOrderVorticity
LOGICAL useAbsVorticity
LOGICAL upwindShear
LOGICAL implicitDiffusion
LOGICAL implicitViscosity
LOGICAL tempImplVertAdv
LOGICAL saltImplVertAdv
LOGICAL momImplVertAdv
LOGICAL multiDimAdvection
LOGICAL useMultiDimAdvec
LOGICAL momDissip_In_AB
LOGICAL doAB_onGtGs
LOGICAL balanceEmPmR
LOGICAL balanceQnet
LOGICAL balancePrintMean
LOGICAL doThetaClimRelax
LOGICAL doSaltClimRelax
LOGICAL allowFreezing
LOGICAL useOldFreezing
LOGICAL periodicExternalForcing
LOGICAL globalFiles
LOGICAL useSingleCpuIO
LOGICAL pickupStrictlyMatch
LOGICAL usePickupBeforeC54
LOGICAL startFromPickupAB2
LOGICAL pickup_read_mdsio, pickup_write_mdsio
LOGICAL pickup_write_immed, writePickupAtEnd
LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
LOGICAL outputTypesInclusive
LOGICAL dumpInitAndLast
LOGICAL debugMode
LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
C cg2dTargetResidual
C :: Target residual for cg2d solver; no unit (RHS normalisation)
C cg2dTargetResWunit
C :: Target residual for cg2d solver; W unit (No RHS normalisation)
C cg3dTargetResidual
C :: Target residual for cg3d solver.
C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
C Note. 20th May 1998
C I made a weird discovery! In the model paper we argue
C for the form of the preconditioner used here ( see
C A Finite-volume, Incompressible Navier-Stokes Model
C ...., Marshall et. al ). The algebra gives a simple
C 0.5 factor for the averaging of ac and aCw to get a
C symmettric pre-conditioner. By using a factor of 0.51
C i.e. scaling the off-diagonal terms in the
C preconditioner down slightly I managed to get the
C number of iterations for convergence in a test case to
C drop form 192 -> 134! Need to investigate this further!
C For now I have introduced a parameter cg2dpcOffDFac which
C defaults to 0.51 but can be set at runtime.
C delR :: Vertical grid spacing ( units of r ).
C delRc :: Vertical grid spacing between cell centers (r unit).
C delX :: Separation between cell faces (m) or (deg), depending
C delY on input flags.
C gravity :: Accel. due to gravity ( m/s^2 )
C recip_gravity and its inverse
C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 )
C rhoNil :: Reference density for the linear equation of state
C rhoConst :: Vertically constant reference density
C rhoFacC :: normalized (by rhoConst) reference density at cell-Center
C rhoFacF :: normalized (by rhoConst) reference density at cell-interFace
C rhoConstFresh :: Constant reference density for fresh water (rain)
C tRef :: reference vertical profile for potential temperature
C sRef :: reference vertical profile for salinity/specific humidity
C phiRef :: reference potential (pressure/rho, geopotential) profile
C dBdrRef :: vertical gradient of reference boyancy [(m/s/r)^2)]:
C :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
C :: p-coord: = -(d.alpha/dp)_ref [(m^2.s/kg)^2]
C rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
C :: from r-coordinate vertical velocity to vertical velocity [m/s].
C :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit
C wUnit2rVel :: units conversion factor (Non-Hydrostatic code),
C :: from vertical velocity [m/s] to r-coordinate vertical velocity.
C :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel
C mass2rUnit :: units conversion factor (surface forcing),
C :: from mass per unit area [kg/m2] to vertical r-coordinate unit.
C :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ;
C :: p-coord: = gravity ( [kg/m2] * g = [Pa] ) ;
C rUnit2mass :: units conversion factor (surface forcing),
C :: from vertical r-coordinate unit to mass per unit area [kg/m2].
C :: z-coord: = rhoConst ( [m] * rho = [kg/m2] ) ;
C :: p-coord: = 1/gravity ( [Pa] / g = [kg/m2] ) ;
C phiMin :: Latitude of southern most cell face.
C thetaMin :: Longitude of western most cell face (this
C is an "inert" parameter but it is included
C to make geographical references simple.)
C rSphere :: Radius of sphere for a spherical polar grid ( m ).
C recip_rSphere :: Reciprocal radius of sphere ( m ).
C f0 :: Reference coriolis parameter ( 1/s )
C ( Southern edge f for beta plane )
C beta :: df/dy ( s^-1.m^-1 )
C omega :: Angular velocity ( rad/s )
C rotationPeriod :: Rotation period (s) (= 2.pi/omega)
C viscAr :: Eddy viscosity coeff. for mixing of
C momentum vertically ( units of r^2/s )
C viscAh :: Eddy viscosity coeff. for mixing of
C momentum laterally ( m^2/s )
C viscAhW :: Eddy viscosity coeff. for mixing of vertical
C momentum laterally, no effect for hydrostatic
C model, defaults to viscAh if unset ( m^2/s )
C Not used if variable horiz. viscosity is used.
C viscA4 :: Biharmonic viscosity coeff. for mixing of
C momentum laterally ( m^4/s )
C viscA4W :: Biharmonic viscosity coeff. for mixing of vertical
C momentum laterally, no effect for hydrostatic
C model, defaults to viscA4 if unset ( m^2/s )
C Not used if variable horiz. viscosity is used.
C viscAhD :: Eddy viscosity coeff. for mixing of momentum laterally
C (act on Divergence part) ( m^2/s )
C viscAhZ :: Eddy viscosity coeff. for mixing of momentum laterally
C (act on Vorticity part) ( m^2/s )
C viscA4D :: Biharmonic viscosity coeff. for mixing of momentum laterally
C (act on Divergence part) ( m^4/s )
C viscA4Z :: Biharmonic viscosity coeff. for mixing of momentum laterally
C (act on Vorticity part) ( m^4/s )
C viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))
C viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
C viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))
C viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
C viscC2smag :: Smagorinsky non-dimensional viscosity factor (harmonic)
C viscC4smag :: Smagorinsky non-dimensional viscosity factor (biharmonic)
C viscAhMax :: Maximum eddy viscosity coeff. for mixing of
C momentum laterally ( m^2/s )
C viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity
C coeff. for mixing of momentum laterally (non-dim)
C viscAhGrid :: non-dimensional grid-size dependent viscosity
C viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
C viscAhGridMin:: in terms of non-dimensional grid-size dependent visc.
C viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
C momentum laterally ( m^4/s )
C viscA4ReMax :: Maximum Gridscale Reynolds number for
C biharmonic viscosity coeff. momentum laterally (non-dim)
C viscA4Grid :: non-dimensional grid-size dependent bi-harmonic viscosity
C viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
C viscA4GridMin:: in terms of non-dimensional grid-size dependent viscosity
C diffKhT :: Laplacian diffusion coeff. for mixing of
C heat laterally ( m^2/s )
C diffKrNrT :: vertical profile of Laplacian diffusion coeff.
C for mixing of heat vertically ( units of r^2/s )
C diffK4T :: Biharmonic diffusion coeff. for mixing of
C heat laterally ( m^4/s )
C diffKhS :: Laplacian diffusion coeff. for mixing of
C salt laterally ( m^2/s )
C diffKrNrS :: vertical profile of Laplacian diffusion coeff.
C for mixing of salt vertically ( units of r^2/s ),
C diffK4S :: Biharmonic diffusion coeff. for mixing of
C salt laterally ( m^4/s )
C diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
C diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
C diffKrBL79scl :: depth scale for arctan fn (m) Bryan and Lewis, 1979
C diffKrBL79Ho :: depth offset for arctan fn (m) Bryan and Lewis, 1979
C BL79LatVary :: polarwise of this latitude diffKrBL79 is applied with
C gradual transition to diffKrBLEQ towards Equator
C diffKrBLEQsurf :: same as diffKrBL79surf but at Equator
C diffKrBLEQdeep :: same as diffKrBL79deep but at Equator
C diffKrBLEQscl :: same as diffKrBL79scl but at Equator
C diffKrBLEQHo :: same as diffKrBL79Ho but at Equator
C deltaT :: Default timestep ( s )
C deltaTClock :: Timestep used as model "clock". This determines the
C IO frequencies and is used in tagging output. It can
C be totally different to the dynamical time. Typically
C it will be the deep-water timestep for accelerated runs.
C Frequency of checkpointing and dumping of the model state
C are referenced to this clock. ( s )
C deltaTMom :: Timestep for momemtum equations ( s )
C dTtracerLev :: Timestep for tracer equations ( s ), function of level k
C deltaTfreesurf :: Timestep for free-surface equation ( s )
C freesurfFac :: Parameter to turn implicit free surface term on or off
C freesurfac = 1. uses implicit free surface
C freesurfac = 0. uses rigid lid
C abEps :: Adams-Bashforth-2 stabilizing weight
C alph_AB :: Adams-Bashforth-3 primary factor
C beta_AB :: Adams-Bashforth-3 secondary factor
C implicSurfPress :: parameter of the Crank-Nickelson time stepping :
C Implicit part of Surface Pressure Gradient ( 0-1 )
C implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
C Implicit part of barotropic flow Divergence ( 0-1 )
C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...)
C hFacMinDz :: Minimum dimesional size of a cell (affects hFacC etc..., m)
C hFacMinDp :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
C hFacMinDr :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
C hFacInf :: Threshold (inf and sup) for fraction size of surface cell
C hFacSup that control vanishing and creating levels
C tauCD :: CD scheme coupling timescale ( 1/s )
C rCD :: CD scheme normalised coupling parameter ( 0-1 )
C baseTime :: model base time (time origin) = time @ iteration zero
C startTime :: Starting time for this integration ( s ).
C endTime :: Ending time for this integration ( s ).
C chkPtFreq :: Frequency of rolling check pointing ( s ).
C pChkPtFreq :: Frequency of permanent check pointing ( s ).
C dumpFreq :: Frequency with which model state is written to
C post-processing files ( s ).
C diagFreq :: Frequency with which model writes diagnostic output
C of intermediate quantities.
C afFacMom :: Advection of momentum term tracer parameter
C vfFacMom :: Momentum viscosity tracer parameter
C pfFacMom :: Momentum pressure forcing tracer parameter
C cfFacMom :: Coriolis term tracer parameter
C foFacMom :: Momentum forcing tracer parameter
C mtFacMom :: Metric terms tracer parameter
C cosPower :: Power of cosine of latitude to multiply viscosity
C cAdjFreq :: Frequency of convective adjustment
C
C taveFreq :: Frequency with which time-averaged model state
C is written to post-processing files ( s ).
C tave_lastIter :: (for state variable only) fraction of the last time
C step (of each taveFreq period) put in the time average.
C (fraction for 1rst iter = 1 - tave_lastIter)
C tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
C tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
C latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
C i.e. where |yC| <= latBandClimRelax
C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
C (note: externForcingCycle must be an integer
C number times externForcingPeriod)
C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
C (use model surface (local) value if set to -1)
C temp_EvPrRn :: temperature of Rain & Evap.
C salt_EvPrRn :: salinity of Rain & Evap.
C (notes: a) tracer content of Rain/Evap only used if both
C NonLin_FrSurf & useRealFreshWater are set.
C b) use model surface (local) value if set to UNSET_RL)
C hMixCrit :: criteria for mixed-layer diagnostic
C ivdc_kappa :: implicit vertical diffusivity for convection [m^2/s]
C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
C sideDragFactor :: side-drag scaling factor (used only if no_slip_sides)
C (default=2: full drag ; =1: gives half-slip BC)
C bottomDragLinear :: Linear bottom-drag coefficient (units of [r]/s)
C bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
C (if using zcoordinate, units becomes linear: m/s, quadratic: [-])
C smoothAbsFuncRange :: 1/2 of interval around zero, for which FORTRAN ABS
C is to be replace by a smoother function
C (affects myabs, mymin, mymax)
C nh_Am2 :: scales the non-hydrostatic terms and changes internal scales
C (i.e. allows convection at different Rayleigh numbers)
C phiEuler :: Euler angle, rotation about original z-axis
C thetaEuler :: Euler angle, rotation about new x-axis
C psiEuler :: Euler angle, rotation about new z-axis
COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
& cg2dpcOffDFac, cg3dTargetResidual,
& delR, delRc, delX, delY,
& deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
& abEps, alph_AB, beta_AB,
& phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
& viscAh, viscAhW, viscAhMax,
& viscAhGrid, viscAhGridMax, viscAhGridMin,
& viscC2leith, viscC2leithD,
& viscC2smag, viscC4smag,
& viscAhD, viscAhZ, viscA4D, viscA4Z,
& viscA4, viscA4W, viscA4Max,
& viscA4Grid, viscA4GridMax, viscA4GridMin,
& viscAhReMax, viscA4ReMax,
& viscC4leith, viscC4leithD, viscAr,
& diffKhT, diffK4T, diffKrNrT,
& diffKhS, diffK4S, diffKrNrS,
& diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
& BL79LatVary,
& diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
& delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
& hFacMin, hFacMinDz, hFacInf, hFacSup,
& gravity, recip_gravity, gBaro,
& rhonil, recip_rhonil, rhoConst, recip_rhoConst,
& rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
& rhoConstFresh, tRef, sRef, phiRef, dBdrRef,
& rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
& baseTime, startTime, endTime,
& chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
& diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
& afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
& cosPower, cAdjFreq, omega, rotationPeriod,
& tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
& externForcingCycle, externForcingPeriod,
& convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
& hFacMinDr, hFacMinDp,
& ivdc_kappa, hMixCriteria, Ro_SeaLevel,
& sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
& smoothAbsFuncRange,
& tCylIn, tCylOut,
& phiEuler, thetaEuler, psiEuler
Real*8 cg2dTargetResidual
Real*8 cg2dTargetResWunit
Real*8 cg3dTargetResidual
Real*8 cg2dpcOffDFac
Real*8 delR(Nr)
Real*8 delRc(Nr+1)
Real*8 delX(Nx)
Real*8 delY(Ny)
Real*8 deltaT
Real*8 deltaTClock
Real*8 deltaTmom
Real*8 dTtracerLev(Nr)
Real*8 deltaTfreesurf
Real*8 abEps, alph_AB, beta_AB
Real*8 phiMin
Real*8 thetaMin
Real*8 rSphere
Real*8 recip_rSphere
Real*8 f0
Real*8 freeSurfFac
Real*8 implicSurfPress
Real*8 implicDiv2Dflow
Real*8 hFacMin
Real*8 hFacMinDz
Real*8 hFacMinDp
Real*8 hFacMinDr
Real*8 hFacInf
Real*8 hFacSup
Real*8 beta
Real*8 viscAr
Real*8 viscAh
Real*8 viscAhW
Real*8 viscAhD
Real*8 viscAhZ
Real*8 viscAhMax
Real*8 viscAhReMax
Real*8 viscAhGrid, viscAhGridMax, viscAhGridMin
Real*8 viscC2leith
Real*8 viscC2leithD
Real*8 viscC2smag
Real*8 viscA4
Real*8 viscA4W
Real*8 viscA4D
Real*8 viscA4Z
Real*8 viscA4Max
Real*8 viscA4ReMax
Real*8 viscA4Grid, viscA4GridMax, viscA4GridMin
Real*8 viscC4leith
Real*8 viscC4leithD
Real*8 viscC4smag
Real*8 diffKhT
Real*8 diffKrNrT(Nr)
Real*8 diffK4T
Real*8 diffKhS
Real*8 diffKrNrS(Nr)
Real*8 diffK4S
Real*8 diffKrBL79surf
Real*8 diffKrBL79deep
Real*8 diffKrBL79scl
Real*8 diffKrBL79Ho
Real*8 BL79LatVary
Real*8 diffKrBLEQsurf
Real*8 diffKrBLEQdeep
Real*8 diffKrBLEQscl
Real*8 diffKrBLEQHo
Real*8 delt
Real*8 tauCD
Real*8 rCD
Real*8 gravity
Real*8 recip_gravity
Real*8 gBaro
Real*8 rhonil, recip_rhonil
Real*8 rhoConst, recip_rhoConst
Real*8 rhoFacC(Nr), recip_rhoFacC(Nr)
Real*8 rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
Real*8 rhoConstFresh
Real*8 tRef(Nr)
Real*8 sRef(Nr)
Real*8 phiRef(2*Nr+1)
Real*8 dBdrRef(Nr)
Real*8 rVel2wUnit(Nr+1), wUnit2rVel(Nr+1)
Real*8 mass2rUnit, rUnit2mass
Real*8 baseTime
Real*8 startTime
Real*8 endTime
Real*8 chkPtFreq
Real*8 pChkPtFreq
Real*8 dumpFreq
Real*8 adjDumpFreq
Real*8 diagFreq
Real*8 taveFreq
Real*8 tave_lastIter
Real*8 monitorFreq
Real*8 adjMonitorFreq
Real*8 afFacMom
Real*8 vfFacMom
Real*8 pfFacMom
Real*8 cfFacMom
Real*8 foFacMom
Real*8 mtFacMom
Real*8 cosPower
Real*8 cAdjFreq
Real*8 omega
Real*8 rotationPeriod
Real*8 tauThetaClimRelax
Real*8 tauSaltClimRelax
Real*8 latBandClimRelax
Real*8 externForcingCycle
Real*8 externForcingPeriod
Real*8 convertFW2Salt
Real*8 temp_EvPrRn
Real*8 salt_EvPrRn
Real*8 ivdc_kappa
Real*8 hMixCriteria
Real*8 Ro_SeaLevel
Real*8 sideDragFactor
Real*8 bottomDragLinear
Real*8 bottomDragQuadratic
Real*8 smoothAbsFuncRange
Real*8 nh_Am2
Real*8 tCylIn
Real*8 tCylOut
Real*8 phiEuler, thetaEuler, psiEuler
C-- COMMON /PARM_A/ Thermodynamics constants ?
COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
Real*8 HeatCapacity_Cp
Real*8 recip_Cp
C-- COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
C celsius2K :: convert centigrade (Celsius) degree to Kelvin
C atm_Po :: standard reference pressure
C atm_Cp :: specific heat (Cp) of the (dry) air at constant pressure
C atm_Rd :: gas constant for dry air
C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
C atm_Rq :: water vapour specific volume anomaly relative to dry air
C (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
C integr_GeoPot :: option to select the way we integrate the geopotential
C (still a subject of discussions ...)
C selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
C derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
COMMON /PARM_ATM/
& celsius2K,
& atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
& integr_GeoPot, selectFindRoSurf
Real*8 celsius2K
Real*8 atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
INTEGER integr_GeoPot, selectFindRoSurf
C Logical flags for selecting packages
LOGICAL useOPPS
LOGICAL usePP81
LOGICAL useMY82
LOGICAL useGGL90
LOGICAL useKPP
LOGICAL useGAD
LOGICAL useGMRedi
LOGICAL useOBCS
LOGICAL useAIM
LOGICAL useLand
LOGICAL useCAL
LOGICAL useEXF
LOGICAL useEBM
LOGICAL useGrdchk
LOGICAL useECCO
LOGICAL useSHAP_FILT
LOGICAL useZONAL_FILT
LOGICAL useFLT
LOGICAL usePTRACERS
LOGICAL useGCHEM
LOGICAL useRBCS
LOGICAL useOffLine
LOGICAL useMATRIX
LOGICAL useSBO
LOGICAL useSEAICE
LOGICAL useShelfIce
LOGICAL useThSIce
LOGICAL useATM2d
LOGICAL useBulkForce
LOGICAL usefizhi
LOGICAL usegridalt
LOGICAL useDiagnostics
LOGICAL useMNC
LOGICAL useREGRID
LOGICAL useRunClock
LOGICAL useEMBED_FILES
LOGICAL useMYPACKAGE
LOGICAL useSALT_PLUME
COMMON /PARM_PACKAGES/
& useOPPS, usePP81, useMY82, useGGL90, useKPP,
& useGAD, useGMRedi, useOBCS, useAIM, useLand,
& useCAL, useEXF, useEBM, useGrdchk, useECCO,
& useSHAP_FILT, useZONAL_FILT, useFLT,
& usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
& useSBO, useSEAICE, useShelfIce,
& useThSIce, useATM2D, useBulkForce,
& usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID,
& useRunClock, useEMBED_FILES, useMYPACKAGE, useSALT_PLUME
CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
c#include "cal.h"
C $Header: /u/gcmpack/MITgcm/pkg/exf/EXF_PARAM.h,v 1.9 2008/02/22 20:25:54 dimitri Exp $
C $Name: $
c
c
c ==================================================================
c HEADER exf_param
c ==================================================================
c
c o Header file for the surface flux data. Used by the external
c forcing package.
c
c started: Christian Eckert eckert@mit.edu 30-Jun-1999
c
c changed: Christian Eckert eckert@mit.edu 14-Jan-2000
c - Restructured the original version in order to have a
c better interface to the MITgcmUV.
c
c Christian Eckert eckert@mit.edu 12-Feb-2000
c - Changed some variables names (package prefix: exf_)
c
c Patrick Heimbach, heimbach@mit.edu 04-May-2000
c - included exf_iprec, exf_yftype to enable easy
c switch between 32bit/64 bit data format
c
c Patrick Heimbach, heimbach@mit.edu 01-May-2001
c - added obcs parameters
c
c mods for pkg/seaice: menemenlis@jpl.nasa.gov 20-Dec-2002
c
c ==================================================================
c HEADER exf_param
c ==================================================================
c year in seconds
Real*8 year2sec
c Calendar data.
Real*8 repeatPeriod
c Monitor Frequency (s)
Real*8 exf_monFreq
c Drag coefficient scaling factor
Real*8 exf_scal_BulkCdn
c Maximum absolute windstress, used to reset unreastically high
c data values
Real*8 windstressmax
integer hfluxstartdate1
integer hfluxstartdate2
Real*8 hfluxstartdate
Real*8 hfluxperiod
Real*8 hfluxconst
Real*8 hflux_exfremo_intercept
Real*8 hflux_exfremo_slope
character*1 hfluxmask
parameter( hfluxmask = 's' )
integer atempstartdate1
integer atempstartdate2
Real*8 atempstartdate
Real*8 atempperiod
Real*8 atempconst
Real*8 atemp_exfremo_intercept
Real*8 atemp_exfremo_slope
character*1 atempmask
parameter( atempmask = 's' )
integer aqhstartdate1
integer aqhstartdate2
Real*8 aqhstartdate
Real*8 aqhperiod
Real*8 aqhconst
Real*8 aqh_exfremo_intercept
Real*8 aqh_exfremo_slope
character*1 aqhmask
parameter( aqhmask = 's' )
integer sfluxstartdate1
integer sfluxstartdate2
Real*8 sfluxstartdate
Real*8 sfluxperiod
Real*8 sfluxconst
Real*8 sflux_exfremo_intercept
Real*8 sflux_exfremo_slope
character*1 sfluxmask
parameter( sfluxmask = 's' )
integer evapstartdate1
integer evapstartdate2
Real*8 evapstartdate
Real*8 evapperiod
Real*8 evapconst
Real*8 evap_exfremo_intercept
Real*8 evap_exfremo_slope
character*1 evapmask
parameter( evapmask = 's' )
integer precipstartdate1
integer precipstartdate2
Real*8 precipstartdate
Real*8 precipperiod
Real*8 precipconst
Real*8 precip_exfremo_intercept
Real*8 precip_exfremo_slope
character*1 precipmask
parameter( precipmask = 's' )
integer snowprecipstartdate1
integer snowprecipstartdate2
Real*8 snowprecipstartdate
Real*8 snowprecipperiod
Real*8 snowprecipconst
Real*8 snowprecip_exfremo_intercept
Real*8 snowprecip_exfremo_slope
character*1 snowprecipmask
parameter( snowprecipmask = 's' )
integer runoffstartdate1
integer runoffstartdate2
Real*8 runoffstartdate
Real*8 runoffperiod
Real*8 runoffconst
Real*8 runoff_exfremo_intercept
Real*8 runoff_exfremo_slope
character*1 runoffmask
parameter( runoffmask = 's' )
integer ustressstartdate1
integer ustressstartdate2
Real*8 ustressstartdate
Real*8 ustressperiod
Real*8 ustressconst
Real*8 ustress_exfremo_intercept
Real*8 ustress_exfremo_slope
character*1 ustressmask
parameter( ustressmask = 'u' )
integer vstressstartdate1
integer vstressstartdate2
Real*8 vstressstartdate
Real*8 vstressperiod
Real*8 vstressconst
Real*8 vstress_exfremo_intercept
Real*8 vstress_exfremo_slope
character*1 vstressmask
parameter( vstressmask = 'v' )
integer uwindstartdate1
integer uwindstartdate2
Real*8 uwindstartdate
Real*8 uwindperiod
Real*8 uwindconst
Real*8 uwind_exfremo_intercept
Real*8 uwind_exfremo_slope
character*1 uwindmask
parameter( uwindmask = 's' )
integer vwindstartdate1
integer vwindstartdate2
Real*8 vwindstartdate
Real*8 vwindperiod
Real*8 vwindconst
Real*8 vwind_exfremo_intercept
Real*8 vwind_exfremo_slope
character*1 vwindmask
parameter( vwindmask = 's' )
integer wspeedstartdate1
integer wspeedstartdate2
Real*8 wspeedstartdate
Real*8 wspeedperiod
Real*8 wspeedconst
Real*8 wspeed_exfremo_intercept
Real*8 wspeed_exfremo_slope
character*1 wspeedmask
parameter( wspeedmask = 's' )
integer swfluxstartdate1
integer swfluxstartdate2
Real*8 swfluxstartdate
Real*8 swfluxperiod
Real*8 swfluxconst
Real*8 swflux_exfremo_intercept
Real*8 swflux_exfremo_slope
character*1 swfluxmask
parameter( swfluxmask = 's' )
integer lwfluxstartdate1
integer lwfluxstartdate2
Real*8 lwfluxstartdate
Real*8 lwfluxperiod
Real*8 lwfluxconst
Real*8 lwflux_exfremo_intercept
Real*8 lwflux_exfremo_slope
character*1 lwfluxmask
parameter( lwfluxmask = 's' )
integer swdownstartdate1
integer swdownstartdate2
Real*8 swdownstartdate
Real*8 swdownperiod
Real*8 swdownconst
Real*8 swdown_exfremo_intercept
Real*8 swdown_exfremo_slope
character*1 swdownmask
parameter( swdownmask = 's' )
integer lwdownstartdate1
integer lwdownstartdate2
Real*8 lwdownstartdate
Real*8 lwdownperiod
Real*8 lwdownconst
Real*8 lwdown_exfremo_intercept
Real*8 lwdown_exfremo_slope
character*1 lwdownmask
parameter( lwdownmask = 's' )
integer apressurestartdate1
integer apressurestartdate2
Real*8 apressurestartdate
Real*8 apressureperiod
Real*8 apressureconst
Real*8 apressure_exfremo_intercept
Real*8 apressure_exfremo_slope
character*1 apressuremask
parameter( apressuremask = 's' )
c Calendar data.
integer climsststartdate1
integer climsststartdate2
Real*8 climsststartdate
Real*8 climsstperiod
Real*8 climsstconst
Real*8 climsst_exfremo_intercept
Real*8 climsst_exfremo_slope
character*1 climsstmask
parameter( climsstmask = 's' )
integer climsssstartdate1
integer climsssstartdate2
Real*8 climsssstartdate
Real*8 climsssperiod
Real*8 climsssconst
Real*8 climsss_exfremo_intercept
Real*8 climsss_exfremo_slope
character*1 climsssmask
parameter( climsssmask = 's' )
c freezing temperature is the minimum temperature allowed, used
c to reset climatological temperatures fields where they have
c values below climtempfreeze
Real*8 climtempfreeze
c the following variables are used in conjunction with pkg/obcs
c to describe S/T/U/V open boundary condition files
integer obcsNstartdate1
integer obcsNstartdate2
integer obcsSstartdate1
integer obcsSstartdate2
integer obcsEstartdate1
integer obcsEstartdate2
integer obcsWstartdate1
integer obcsWstartdate2
Real*8 obcsNstartdate
Real*8 obcsNperiod
Real*8 obcsSstartdate
Real*8 obcsSperiod
Real*8 obcsEstartdate
Real*8 obcsEperiod
Real*8 obcsWstartdate
Real*8 obcsWperiod
c the following variables are used in conjunction with pkg/obcs
c and pkg/seaice to describe area, heff, hsnow, hsalt, uice,
c and vice open boundary condition files
integer siobNstartdate1
integer siobNstartdate2
integer siobSstartdate1
integer siobSstartdate2
integer siobEstartdate1
integer siobEstartdate2
integer siobWstartdate1
integer siobWstartdate2
Real*8 siobNstartdate
Real*8 siobNperiod
Real*8 siobSstartdate
Real*8 siobSperiod
Real*8 siobEstartdate
Real*8 siobEperiod
Real*8 siobWstartdate
Real*8 siobWperiod
c File names.
character*(128) hfluxfile
character*(128) atempfile
character*(128) aqhfile
character*(128) evapfile
character*(128) precipfile
character*(128) snowprecipfile
character*(128) sfluxfile
character*(128) runofffile
character*(128) ustressfile
character*(128) vstressfile
character*(128) uwindfile
character*(128) vwindfile
character*(128) wspeedfile
character*(128) swfluxfile
character*(128) lwfluxfile
character*(128) swdownfile
character*(128) lwdownfile
character*(128) apressurefile
character*(128) climsstfile
character*(128) climsssfile
C useExfYearlyFields :: when set, automatically add extension
C _YEAR to input file names; the yearly files need
C to contain all the records that pertain to
C a particular year, including day 1, hour zero
C twoDigitYear :: when set, use 2-digit year extension YR
C instead of _YEAR for useExfYearlyFields
C readStressOnAgrid :: read wind-streess located on model-grid, A-grid position
C readStressOnCgrid :: read wind-streess located on model-grid, C-grid position
C stressIsOnCgrid :: ustress & vstress are positioned on Arakawa C-grid
C useStabilityFct_overIce :: over sea-ice, compute turbulent transfert
C coeff. function of stability (like over
C open ocean) rather than using fixed Coeff.
C useRelativeWind :: Subtract U/VVEL or U/VICE from U/VWIND before computing U/VSTRESS
logical useExfYearlyFields, twoDigitYear
logical useExfCheckRange
logical readStressOnAgrid
logical readStressOnCgrid
logical stressIsOnCgrid
logical useStabilityFct_overIce
logical useRelativeWind
common /exf_param_l/
& useExfYearlyFields, twoDigitYear,
& useExfCheckRange,
& readStressOnAgrid, readStressOnCgrid,
& stressIsOnCgrid, useStabilityFct_overIce,
& useRelativeWind
common /exf_param_i/
& hfluxstartdate1, hfluxstartdate2,
& atempstartdate1, atempstartdate2,
& aqhstartdate1, aqhstartdate2,
& sfluxstartdate1, sfluxstartdate2,
& evapstartdate1, evapstartdate2,
& runoffstartdate1, runoffstartdate2,
& precipstartdate1, precipstartdate2,
& snowprecipstartdate1, snowprecipstartdate2,
& ustressstartdate1, ustressstartdate2,
& vstressstartdate1, vstressstartdate2,
& uwindstartdate1, uwindstartdate2,
& vwindstartdate1, vwindstartdate2,
& wspeedstartdate1, wspeedstartdate2,
& swfluxstartdate1, swfluxstartdate2,
& lwfluxstartdate1, lwfluxstartdate2,
& swdownstartdate1, swdownstartdate2,
& lwdownstartdate1, lwdownstartdate2,
& obcsNstartdate1, obcsNstartdate2,
& obcsSstartdate1, obcsSstartdate2,
& obcsEstartdate1, obcsEstartdate2,
& obcsWstartdate1, obcsWstartdate2,
& siobNstartdate1, siobNstartdate2,
& siobSstartdate1, siobSstartdate2,
& siobEstartdate1, siobEstartdate2,
& siobWstartdate1, siobWstartdate2,
& apressurestartdate1,apressurestartdate2
common /exf_param_r/
& year2sec, windstressmax,
& repeatPeriod, exf_monFreq,
& exf_scal_BulkCdn,
& hfluxperiod, hfluxstartdate,
& atempperiod, atempstartdate,
& aqhperiod, aqhstartdate,
& sfluxperiod, sfluxstartdate,
& evapperiod, evapstartdate,
& precipperiod, precipstartdate,
& snowprecipperiod, snowprecipstartdate,
& runoffperiod, runoffstartdate,
& ustressperiod, ustressstartdate,
& vstressperiod, vstressstartdate,
& uwindperiod, uwindstartdate,
& vwindperiod, vwindstartdate,
& wspeedperiod, wspeedstartdate,
& swfluxperiod, swfluxstartdate,
& lwfluxperiod, lwfluxstartdate,
& swdownperiod, swdownstartdate,
& lwdownperiod, lwdownstartdate,
& obcsNperiod, obcsNstartdate,
& obcsSperiod, obcsSstartdate,
& obcsEperiod, obcsEstartdate,
& obcsWperiod, obcsWstartdate,
& siobNperiod, siobNstartdate,
& siobSperiod, siobSstartdate,
& siobEperiod, siobEstartdate,
& siobWperiod, siobWstartdate,
& apressureperiod, apressurestartdate,
& hfluxconst,
& atempconst,
& aqhconst,
& sfluxconst,
& evapconst,
& precipconst,
& snowprecipconst,
& runoffconst,
& ustressconst,
& vstressconst,
& uwindconst,
& vwindconst,
& wspeedconst,
& swfluxconst,
& lwfluxconst,
& swdownconst,
& lwdownconst,
& apressureconst
common /exf_param_trend_removal/
& hflux_exfremo_intercept,
& atemp_exfremo_intercept,
& aqh_exfremo_intercept,
& sflux_exfremo_intercept,
& evap_exfremo_intercept,
& precip_exfremo_intercept,
& snowprecip_exfremo_intercept,
& runoff_exfremo_intercept,
& ustress_exfremo_intercept,
& vstress_exfremo_intercept,
& uwind_exfremo_intercept,
& vwind_exfremo_intercept,
& wspeed_exfremo_intercept,
& swflux_exfremo_intercept,
& lwflux_exfremo_intercept,
& swdown_exfremo_intercept,
& lwdown_exfremo_intercept,
& apressure_exfremo_intercept,
& hflux_exfremo_slope,
& atemp_exfremo_slope,
& aqh_exfremo_slope,
& sflux_exfremo_slope,
& evap_exfremo_slope,
& precip_exfremo_slope,
& snowprecip_exfremo_slope,
& runoff_exfremo_slope,
& ustress_exfremo_slope,
& vstress_exfremo_slope,
& uwind_exfremo_slope,
& vwind_exfremo_slope,
& wspeed_exfremo_slope,
& swflux_exfremo_slope,
& lwflux_exfremo_slope,
& swdown_exfremo_slope,
& lwdown_exfremo_slope,
& apressure_exfremo_slope
common /exf_param_c/
& hfluxfile,
& atempfile,
& aqhfile,
& sfluxfile,
& evapfile,
& precipfile,
& snowprecipfile,
& runofffile,
& ustressfile,
& vstressfile,
& uwindfile,
& vwindfile,
& wspeedfile,
& swfluxfile,
& lwfluxfile,
& swdownfile,
& lwdownfile,
& apressurefile
common /exf_clim_i/
& climsststartdate1, climsststartdate2,
& climsssstartdate1, climsssstartdate2
common /exf_clim_c/
& climsstfile,
& climsssfile
common /exf_clim_r/
& climtempfreeze,
& climsstperiod, climsststartdate,
& climsssperiod, climsssstartdate,
& climsstconst, climsssconst,
& climsst_exfremo_intercept, climsst_exfremo_slope,
& climsss_exfremo_intercept, climsss_exfremo_slope,
& exf_inscal_climsst, exf_inscal_climsss
c file precision and field type
common /exf_param_type/
& exf_iprec,
& exf_yftype
integer exf_iprec
character*(2) exf_yftype
c exf_inscal_* input scaling factors
c exf_offset_atemp input air temperature offset
c (for conversion from C to K, if needed)
c exf_outscale_* output scaling factors
Real*8 exf_inscal_hflux
Real*8 exf_inscal_sflux
Real*8 exf_inscal_ustress
Real*8 exf_inscal_vstress
Real*8 exf_inscal_uwind
Real*8 exf_inscal_vwind
Real*8 exf_inscal_wspeed
Real*8 exf_inscal_swflux
Real*8 exf_inscal_lwflux
Real*8 exf_inscal_precip
Real*8 exf_inscal_snowprecip
Real*8 exf_inscal_sst
Real*8 exf_inscal_sss
Real*8 exf_inscal_atemp
Real*8 exf_offset_atemp
Real*8 exf_inscal_aqh
Real*8 exf_inscal_evap
Real*8 exf_inscal_apressure
Real*8 exf_inscal_runoff
Real*8 exf_inscal_swdown
Real*8 exf_inscal_lwdown
Real*8 exf_inscal_climsst
Real*8 exf_inscal_climsss
Real*8 exf_outscal_hflux
Real*8 exf_outscal_sflux
Real*8 exf_outscal_ustress
Real*8 exf_outscal_vstress
Real*8 exf_outscal_swflux
Real*8 exf_outscal_sst
Real*8 exf_outscal_sss
Real*8 exf_outscal_apressure
common /exf_param_scal/
& exf_inscal_hflux
& , exf_inscal_sflux
& , exf_inscal_ustress
& , exf_inscal_vstress
& , exf_inscal_uwind
& , exf_inscal_vwind
& , exf_inscal_wspeed
& , exf_inscal_swflux
& , exf_inscal_lwflux
& , exf_inscal_precip
& , exf_inscal_snowprecip
& , exf_inscal_sst
& , exf_inscal_sss
& , exf_inscal_atemp
& , exf_offset_atemp
& , exf_inscal_aqh
& , exf_inscal_evap
& , exf_inscal_apressure
& , exf_inscal_runoff
& , exf_inscal_swdown
& , exf_inscal_lwdown
& , exf_outscal_hflux
& , exf_outscal_sflux
& , exf_outscal_ustress
& , exf_outscal_vstress
& , exf_outscal_swflux
& , exf_outscal_sst
& , exf_outscal_sss
& , exf_outscal_apressure
C To read input data without dynamical allocation ( undef),
C buffer size currently set to 65000 (allows to read-in a 1x1 global data set)
INTEGER exf_interp_bufferSize
PARAMETER( exf_interp_bufferSize = 65000 )
c for lat interpolation, arraysize currently set to 2176 max data values
integer MAX_LAT_INC
parameter(MAX_LAT_INC = 2176)
Real*8 ustress_lon0, ustress_lon_inc
Real*8 ustress_lat0, ustress_lat_inc(MAX_LAT_INC)
INTEGER ustress_nlon, ustress_nlat
Real*8 vstress_lon0, vstress_lon_inc
Real*8 vstress_lat0, vstress_lat_inc(MAX_LAT_INC)
INTEGER vstress_nlon, vstress_nlat
Real*8 hflux_lon0, hflux_lon_inc
Real*8 hflux_lat0, hflux_lat_inc(MAX_LAT_INC)
INTEGER hflux_nlon, hflux_nlat
Real*8 sflux_lon0, sflux_lon_inc
Real*8 sflux_lat0, sflux_lat_inc(MAX_LAT_INC)
INTEGER sflux_nlon, sflux_nlat
Real*8 swflux_lon0, swflux_lon_inc
Real*8 swflux_lat0, swflux_lat_inc(MAX_LAT_INC)
INTEGER swflux_nlon, swflux_nlat
Real*8 runoff_lon0, runoff_lon_inc
Real*8 runoff_lat0, runoff_lat_inc(MAX_LAT_INC)
INTEGER runoff_nlon, runoff_nlat
Real*8 atemp_lon0, atemp_lon_inc
Real*8 atemp_lat0, atemp_lat_inc(MAX_LAT_INC)
INTEGER atemp_nlon, atemp_nlat
Real*8 aqh_lon0, aqh_lon_inc
Real*8 aqh_lat0, aqh_lat_inc(MAX_LAT_INC)
INTEGER aqh_nlon, aqh_nlat
Real*8 evap_lon0, evap_lon_inc
Real*8 evap_lat0, evap_lat_inc(MAX_LAT_INC)
INTEGER evap_nlon, evap_nlat
Real*8 precip_lon0, precip_lon_inc
Real*8 precip_lat0, precip_lat_inc(MAX_LAT_INC)
INTEGER precip_nlon, precip_nlat
Real*8 snowprecip_lon0, snowprecip_lon_inc
Real*8 snowprecip_lat0, snowprecip_lat_inc(MAX_LAT_INC)
INTEGER snowprecip_nlon, snowprecip_nlat
Real*8 uwind_lon0, uwind_lon_inc
Real*8 uwind_lat0, uwind_lat_inc(MAX_LAT_INC)
INTEGER uwind_nlon, uwind_nlat
Real*8 vwind_lon0, vwind_lon_inc
Real*8 vwind_lat0, vwind_lat_inc(MAX_LAT_INC)
INTEGER vwind_nlon, vwind_nlat
Real*8 wspeed_lon0, wspeed_lon_inc
Real*8 wspeed_lat0, wspeed_lat_inc(MAX_LAT_INC)
INTEGER wspeed_nlon, wspeed_nlat
Real*8 lwflux_lon0, lwflux_lon_inc
Real*8 lwflux_lat0, lwflux_lat_inc(MAX_LAT_INC)
INTEGER lwflux_nlon, lwflux_nlat
Real*8 swdown_lon0, swdown_lon_inc
Real*8 swdown_lat0, swdown_lat_inc(MAX_LAT_INC)
INTEGER swdown_nlon, swdown_nlat
Real*8 lwdown_lon0, lwdown_lon_inc
Real*8 lwdown_lat0, lwdown_lat_inc(MAX_LAT_INC)
INTEGER lwdown_nlon, lwdown_nlat
Real*8 apressure_lon0,apressure_lon_inc
Real*8 apressure_lat0,apressure_lat_inc(MAX_LAT_INC)
INTEGER apressure_nlon,apressure_nlat
common /exf_interpolation/
& ustress_lon0, ustress_lon_inc,
& ustress_lat0, ustress_lat_inc,
& ustress_nlon, ustress_nlat,
& vstress_lon0, vstress_lon_inc,
& vstress_lat0, vstress_lat_inc,
& vstress_nlon, vstress_nlat,
& hflux_lon0, hflux_lon_inc,
& hflux_lat0, hflux_lat_inc,
& hflux_nlon, hflux_nlat,
& sflux_lon0, sflux_lon_inc,
& sflux_lat0, sflux_lat_inc,
& sflux_nlon, sflux_nlat,
& swflux_lon0, swflux_lon_inc,
& swflux_lat0, swflux_lat_inc,
& swflux_nlon, swflux_nlat,
& runoff_lon0, runoff_lon_inc,
& runoff_lat0, runoff_lat_inc,
& runoff_nlon, runoff_nlat,
& atemp_lon0, atemp_lon_inc,
& atemp_lat0, atemp_lat_inc,
& atemp_nlon, atemp_nlat,
& aqh_lon0, aqh_lon_inc,
& aqh_lat0, aqh_lat_inc,
& aqh_nlon, aqh_nlat,
& evap_lon0, evap_lon_inc,
& evap_lat0, evap_lat_inc,
& evap_nlon, evap_nlat,
& precip_lon0, precip_lon_inc,
& precip_lat0, precip_lat_inc,
& precip_nlon, precip_nlat,
& snowprecip_lon0, snowprecip_lon_inc,
& snowprecip_lat0, snowprecip_lat_inc,
& snowprecip_nlon, snowprecip_nlat,
& uwind_lon0, uwind_lon_inc,
& uwind_lat0, uwind_lat_inc,
& uwind_nlon, uwind_nlat,
& vwind_lon0, vwind_lon_inc,
& vwind_lat0, vwind_lat_inc,
& vwind_nlon, vwind_nlat,
& wspeed_lon0, wspeed_lon_inc,
& wspeed_lat0, wspeed_lat_inc,
& wspeed_nlon, wspeed_nlat,
& lwflux_lon0, lwflux_lon_inc,
& lwflux_lat0, lwflux_lat_inc,
& lwflux_nlon, lwflux_nlat,
& swdown_lon0, swdown_lon_inc,
& swdown_lat0, swdown_lat_inc,
& swdown_nlon, swdown_nlat,
& lwdown_lon0, lwdown_lon_inc,
& lwdown_lat0, lwdown_lat_inc,
& lwdown_nlon, lwdown_nlat,
& apressure_lon0,apressure_lon_inc,
& apressure_lat0,apressure_lat_inc,
& apressure_nlon,apressure_nlat
Real*8 climsst_lon0, climsst_lon_inc
Real*8 climsst_lat0, climsst_lat_inc(MAX_LAT_INC)
INTEGER climsst_nlon, climsst_nlat
Real*8 climsss_lon0, climsss_lon_inc
Real*8 climsss_lat0, climsss_lat_inc(MAX_LAT_INC)
INTEGER climsss_nlon, climsss_nlat
common /exf_clim_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
C $Header: /u/gcmpack/MITgcm/pkg/exf/EXF_CONSTANTS.h,v 1.4 2007/05/08 03:48:08 jmc Exp $
C $Name: $
c
c
c ==================================================================
c HEADER exf_constants
c ==================================================================
c
c o Header file for constants.
c These include - numbers (e.g. 1, 2, 1/2, ...)
c - physical constants (e.g. gravitational const.)
c - empirical parameters
c - control parameters (e.g. max. no of iteration)
c
c started: Patrick Heimbach heimbach@mit.edu 06-May-2000
c mods for pkg/seaice: menemenlis@jpl.nasa.gov 20-Dec-2002
c
c ==================================================================
c HEADER exf_constants
c ==================================================================
c 1. numbers
c exf_half 0.5
c exf_one 1.0
c exf_two 2.0
Real*8 exf_half
Real*8 exf_one
Real*8 exf_two
parameter(
& exf_half = 0.5d0 ,
& exf_one = 1.0d0 ,
& exf_two = 2.0d0
& )
real exf_undef
parameter( exf_undef = -9000. )
c 2. physical constants
c stefanBoltzmann :: Stefan-Boltzmann constant [J*K^-4*m^-2*s^-1]
c sigma = (2*pi^5*k^4)/(15*h^3*c^2)
c karman :: von Karman constant
Real*8 stefanBoltzmann
Real*8 karman
parameter ( stefanBoltzmann = 5.670D-8 )
parameter ( karman = 0.4d0 )
c 3. empirical parameters
c To invert the relationship ustar = ustar(umagn) the following
c parameterization is used:
c
c ustar**2 = umagn**2 * CDN(umagn)
c
c / cquadrag_1 * umagn**2 + cquadrag_2; 0 < u < 11 m/s
c CDN(umagn) =
c \ clindrag_1 * umagn + clindrag_2 ; u > 11 m/s
c
c clindrag_[n] - n = 1, 2 coefficients used to evaluate
c LINEAR relationship of Large and Pond 1981
c cquadrag_[n] - n = 1, 2 coefficients used to evaluate
c quadratic relationship
c u11 - u = 11 m/s wind speed
c ustofu11 - ustar = 0.3818 m/s, corresponding to u = 11 m/s
Real*8 clindrag_1, clindrag_2
Real*8 cquadrag_1, cquadrag_2
Real*8 u11
Real*8 ustofu11
parameter (
& ustofu11 = 0.381800d0 ,
& u11 = 11. d0 ,
& clindrag_1 = 0.000065d0 ,
& clindrag_2 = 0.000490d0 ,
& cquadrag_1 = clindrag_1/u11/2 ,
& cquadrag_2 = clindrag_1*u11/2 + clindrag_2
& )
c 4. control parameters
c niter_bulk - Number of iterations to be performed for the
c evaluation of the bulk surface fluxes. The ncom
c model uses 2 hardwired interation steps (loop
c unrolled).
c
integer niter_bulk
parameter ( niter_bulk = 2 )
C 5. other constants or parameters
C cen2kel :: conversion of deg. Centigrade to Kelvin
C gravity_mks :: gravitational acceleration [m/s^2]
C atmrho :: mean atmospheric density [kg/m^3]
C atmcp :: mean atmospheric specific heat [J/kg/K]
C flamb :: latent heat of evaporation [J/kg]
C flami :: latent heat of melting of pure ice [J/kg]
C cvapor_[] :: Coeff to calculate Saturation Specific Humidity
C see e.g. Gill (1982) p.41 Eq. (3.1.15)
C humid_fac :: constant entering the evaluation of the virtual
C temperature
C gamma_blk :: adiabatic lapse rate
C saltsat :: reduction of saturation vapor pressure over salt water
C-- to evaluate turbulent transfert coefficients:
C cdrag_[n] :: n = 1,2,3 coefficients used to evaluate
C drag coefficient
C cstanton_[n] :: n = 1,2 coefficients used to evaluate
C the Stanton number (stable/unstable cond.)
C cdalton :: coefficient used to evaluate the Dalton number
C zolmin :: minimum stability parameter
C psim_fac :: coef used in turbulent fluxes calculation [-]
C zref :: reference height
C hu :: height of mean wind
C ht :: height of mean temperature
C hq :: height of mean rel. humidity
C umin :: minimum absolute wind speed used to evaluate
C drag coefficient [m/s]
C exf_iceCd :: drag coefficient over sea-ice (fixed)
C exf_iceCe :: transfert coeff. over sea-ice, for Evaporation (fixed)
C exf_iceCh :: transfert coeff. over sea-ice, for Sens.Heating (fixed)
C-- radiation:
C exf_albedo :: Sea-water albedo
C ocean_emissivity :: longwave ocean-surface emissivity [-]
C ice_emissivity :: longwave seaice emissivity [-] (with pkg thsice/seaice)
C snow_emissivity :: longwave snow emissivity [-] (with pkg thsice/seaice)
Real*8 cen2kel
Real*8 gravity_mks
Real*8 atmrho
Real*8 atmcp
Real*8 flamb, flami
Real*8 cvapor_fac, cvapor_exp
Real*8 cvapor_fac_ice, cvapor_exp_ice
Real*8 humid_fac
Real*8 gamma_blk
Real*8 saltsat
Real*8 cdrag_1, cdrag_2, cdrag_3
Real*8 cstanton_1, cstanton_2
Real*8 cdalton
Real*8 zolmin
Real*8 psim_fac
Real*8 zref
Real*8 hu
Real*8 ht
Real*8 hq
Real*8 umin
Real*8 exf_iceCd
Real*8 exf_iceCe
Real*8 exf_iceCh
Real*8 exf_albedo
Real*8 ocean_emissivity
Real*8 ice_emissivity
Real*8 snow_emissivity
COMMON /exf_param_r_2/
& cen2kel,
& gravity_mks,
& atmrho,
& atmcp,
& flamb,
& flami,
& cvapor_fac, cvapor_exp,
& cvapor_fac_ice, cvapor_exp_ice,
& humid_fac,
& gamma_blk,
& saltsat,
& cdrag_1, cdrag_2, cdrag_3,
& cstanton_1, cstanton_2,
& cdalton,
& zolmin,
& psim_fac,
& zref,
& hu,
& ht,
& hq,
& umin,
& exf_iceCd, exf_iceCe, exf_iceCh,
& exf_albedo,
& ocean_emissivity,
& ice_emissivity,
& snow_emissivity
c == routine arguments ==
integer myThid
c == local variables ==
integer i, idummy
integer iUnit
character*(max_len_mbuf) msgbuf
c == end of interface ==
c Surface flux data.
NAMELIST /EXF_NML_01/
& windstressmax, repeatPeriod, exf_albedo,
& ocean_emissivity, ice_emissivity, snow_emissivity,
& exf_iceCd, exf_iceCe, exf_iceCh,
& exf_scal_BulkCdn, climtempfreeze,
& exf_iprec, exf_yftype, exf_monFreq,
& useExfYearlyFields, twoDigitYear, useExfCheckRange,
& useStabilityFct_overIce, readStressOnAgrid, readStressOnCgrid,
& useRelativeWind,
& hu, ht, umin, atmrho, atmcp, cen2kel, gravity_mks,
& cdrag_1, cdrag_2, cdrag_3, cstanton_1, cstanton_2, cdalton,
& flamb, flami, zolmin, zref,
& cvapor_fac, cvapor_exp, cvapor_fac_ice, cvapor_exp_ice,
& humid_fac, gamma_blk, saltsat, psim_fac
NAMELIST /EXF_NML_02/
& hfluxfile, atempfile, aqhfile,
& sfluxfile, precipfile, runofffile,
& ustressfile, vstressfile, evapfile,
& snowprecipfile, uwindfile, vwindfile,
& wspeedfile, swfluxfile, lwfluxfile,
& apressurefile, swdownfile, lwdownfile,
& climsstfile, climsssfile,
& hfluxstartdate1, hfluxstartdate2, hfluxperiod,
& atempstartdate1, atempstartdate2, atempperiod,
& aqhstartdate1, aqhstartdate2, aqhperiod,
& sfluxstartdate1, sfluxstartdate2, sfluxperiod,
& evapstartdate1, evapstartdate2, evapperiod,
& precipstartdate1, precipstartdate2, precipperiod,
& snowprecipstartdate1, snowprecipstartdate2, snowprecipperiod,
& runoffstartdate1, runoffstartdate2, runoffperiod,
& ustressstartdate1, ustressstartdate2, ustressperiod,
& vstressstartdate1, vstressstartdate2, vstressperiod,
& uwindstartdate1, uwindstartdate2, uwindperiod,
& vwindstartdate1, vwindstartdate2, vwindperiod,
& wspeedstartdate1, wspeedstartdate2, wspeedperiod,
& swfluxstartdate1, swfluxstartdate2, swfluxperiod,
& lwfluxstartdate1, lwfluxstartdate2, lwfluxperiod,
& swdownstartdate1, swdownstartdate2, swdownperiod,
& lwdownstartdate1, lwdownstartdate2, lwdownperiod,
&apressurestartdate1,apressurestartdate2,apressureperiod,
& climsststartdate1, climsststartdate2, climsstperiod,
& climsssstartdate1, climsssstartdate2, climsssperiod
NAMELIST /EXF_NML_03/
& exf_inscal_hflux, exf_inscal_sflux, exf_inscal_evap,
& exf_inscal_ustress, exf_inscal_vstress,
& exf_inscal_uwind, exf_inscal_vwind, exf_inscal_wspeed,
& exf_inscal_atemp, exf_offset_atemp, exf_inscal_aqh,
& exf_inscal_sst, exf_inscal_sss,
& exf_inscal_swflux, exf_inscal_lwflux, exf_inscal_precip,
& exf_inscal_runoff, exf_inscal_apressure, exf_inscal_snowprecip,
& exf_inscal_swdown, exf_inscal_lwdown,
& exf_inscal_climsst, exf_inscal_climsss,
& exf_outscal_hflux, exf_outscal_ustress, exf_outscal_vstress,
& exf_outscal_swflux, exf_outscal_sst, exf_outscal_sss,
& exf_outscal_sflux, exf_outscal_apressure,
& hfluxconst, atempconst, aqhconst, sfluxconst, evapconst,
& precipconst, snowprecipconst, runoffconst, ustressconst,
& vstressconst, uwindconst, vwindconst, wspeedconst, swfluxconst,
& lwfluxconst, swdownconst, lwdownconst, apressureconst,
& climsstconst, climsssconst,
& hflux_exfremo_intercept, hflux_exfremo_slope,
& atemp_exfremo_intercept, atemp_exfremo_slope,
& aqh_exfremo_intercept, aqh_exfremo_slope,
& sflux_exfremo_intercept, sflux_exfremo_slope,
& evap_exfremo_intercept, evap_exfremo_slope,
& precip_exfremo_intercept, precip_exfremo_slope,
& snowprecip_exfremo_intercept, snowprecip_exfremo_slope,
& runoff_exfremo_intercept, runoff_exfremo_slope,
& ustress_exfremo_intercept, ustress_exfremo_slope,
& vstress_exfremo_intercept, vstress_exfremo_slope,
& uwind_exfremo_intercept, uwind_exfremo_slope,
& vwind_exfremo_intercept, vwind_exfremo_slope,
& wspeed_exfremo_intercept, wspeed_exfremo_slope,
& swflux_exfremo_intercept, swflux_exfremo_slope,
& lwflux_exfremo_intercept, lwflux_exfremo_slope,
& swdown_exfremo_intercept, swdown_exfremo_slope,
& lwdown_exfremo_intercept, lwdown_exfremo_slope,
& apressure_exfremo_intercept, apressure_exfremo_slope,
& climsst_exfremo_intercept, climsst_exfremo_slope,
& climsss_exfremo_intercept, climsss_exfremo_slope
NAMELIST /EXF_NML_04/
& idummy
& , ustress_lon0, ustress_lon_inc, ustress_lat0, ustress_lat_inc,
& vstress_lon0, vstress_lon_inc, vstress_lat0, vstress_lat_inc,
& ustress_nlon, ustress_nlat, vstress_nlon, vstress_nlat,
& hflux_lon0, hflux_lon_inc, hflux_lat0, hflux_lat_inc,
& sflux_lon0, sflux_lon_inc, sflux_lat0, sflux_lat_inc,
& hflux_nlon, hflux_nlat, sflux_nlon, sflux_nlat,
& swflux_lon0, swflux_lon_inc, swflux_lat0, swflux_lat_inc,
& lwflux_lon0, lwflux_lon_inc, lwflux_lat0, lwflux_lat_inc,
& swflux_nlon, swflux_nlat, lwflux_nlon, lwflux_nlat,
& atemp_lon0, atemp_lon_inc, atemp_lat0, atemp_lat_inc,
& atemp_nlon, atemp_nlat,
& aqh_lon0, aqh_lon_inc, aqh_lat0, aqh_lat_inc, aqh_nlon, aqh_nlat,
&evap_lon0,evap_lon_inc,evap_lat0,evap_lat_inc,evap_nlon,evap_nlat,
& precip_lon0, precip_lon_inc, precip_lat0, precip_lat_inc,
& runoff_lon0, runoff_lon_inc, runoff_lat0, runoff_lat_inc,
& precip_nlon, precip_nlat, runoff_nlon, runoff_nlat,
& snowprecip_lon0, snowprecip_lon_inc, snowprecip_nlon,
& snowprecip_lat0, snowprecip_lat_inc, snowprecip_nlat,
& uwind_lon0, uwind_lon_inc, uwind_lat0, uwind_lat_inc,
& vwind_lon0, vwind_lon_inc, vwind_lat0, vwind_lat_inc,
& uwind_nlon, uwind_nlat, vwind_nlon, vwind_nlat,
& wspeed_lon0, wspeed_lon_inc, wspeed_lat0, wspeed_lat_inc,
& wspeed_nlon, wspeed_nlat,
& swdown_lon0, swdown_lon_inc, swdown_lat0, swdown_lat_inc,
& lwdown_lon0, lwdown_lon_inc, lwdown_lat0, lwdown_lat_inc,
& swdown_nlon, swdown_nlat, lwdown_nlon, lwdown_nlat,
& apressure_lon0,apressure_lon_inc,apressure_nlon,
& apressure_lat0,apressure_lat_inc,apressure_nlat,
& climsst_lon0, climsst_lon_inc, climsst_nlon,
& climsst_lat0, climsst_lat_inc, climsst_nlat,
& climsss_lon0, climsss_lon_inc, climsss_nlon,
& climsss_lat0, climsss_lat_inc, climsss_nlat
NAMELIST /EXF_NML_OBCS/
& obcsNstartdate1, obcsNstartdate2, obcsNperiod,
& obcsSstartdate1, obcsSstartdate2, obcsSperiod,
& obcsEstartdate1, obcsEstartdate2, obcsEperiod,
& obcsWstartdate1, obcsWstartdate2, obcsWperiod,
& siobNstartdate1, siobNstartdate2, siobNperiod,
& siobSstartdate1, siobSstartdate2, siobSperiod,
& siobEstartdate1, siobEstartdate2, siobEperiod,
& siobWstartdate1, siobWstartdate2, siobWperiod
IF ( mythid .EQ. 1 ) THEN
c Set default values.
year2sec = 365.*86400.
exf_monFreq = monitorFreq
useExfCheckRange = .TRUE.
readStressOnAgrid = .FALSE.
readStressOnCgrid = .FALSE.
useRelativeWind = .FALSE.
C- default value should be set to main model parameter:
c cen2kel = celsius2K
c gravity_mks = gravity
c atmcp = atm_Cp
c humid_fac = atm_Rq <- default is zero !!!
cen2kel = 273.150d0
gravity_mks = 9.81d0
atmrho = 1.200d0
atmcp = 1005.000d0
flamb = 2500000.000d0
flami = 334000.000d0
cvapor_fac = 640380.000d0
cvapor_exp = 5107.400d0
cvapor_fac_ice = 11637800.000d0
cvapor_exp_ice = 5897.800d0
humid_fac = 0.606d0
gamma_blk = 0.010d0
saltsat = 0.980d0
cdrag_1 = 0.0027000d0
cdrag_2 = 0.0001420d0
cdrag_3 = 0.0000764d0
cstanton_1 = 0.0327d0
cstanton_2 = 0.0180d0
cdalton = 0.0346d0
zolmin = -100.000d0
psim_fac = 5.000d0
zref = 10.000d0
hu = 10.000d0
ht = 2.000d0
umin = 0.5d0
useStabilityFct_overIce = .FALSE.
exf_iceCd = 1.63D-3
exf_iceCe = 1.63D-3
exf_iceCh = 1.63D-3
exf_albedo = 0.1d0
c-- this default is chosen to be backward compatible with
c-- an earlier setting of 5.5 = ocean_emissivity*stefanBoltzmann
ocean_emissivity = 5.50 D-8 / 5.670 D-8
ice_emissivity = 0.95d0
snow_emissivity = 0.95d0
c Calendar data.
hfluxstartdate1 = 0
hfluxstartdate2 = 0
hfluxperiod = 0.0d0
hfluxconst = 0.0d0
hflux_exfremo_intercept = 0.0d0
hflux_exfremo_slope = 0.0d0
atempstartdate1 = 0
atempstartdate2 = 0
atempperiod = 0.0d0
atempconst = celsius2K
atemp_exfremo_intercept = 0.0d0
atemp_exfremo_slope = 0.0d0
aqhstartdate1 = 0
aqhstartdate2 = 0
aqhperiod = 0.0d0
aqhconst = 0.0d0
aqh_exfremo_intercept = 0.0d0
aqh_exfremo_slope = 0.0d0
sfluxstartdate1 = 0
sfluxstartdate2 = 0
sfluxperiod = 0.0d0
sfluxconst = 0.0d0
sflux_exfremo_intercept = 0.0d0
sflux_exfremo_slope = 0.0d0
evapstartdate1 = 0
evapstartdate2 = 0
evapperiod = 0.0d0
evapconst = 0.0d0
evap_exfremo_intercept = 0.0d0
evap_exfremo_slope = 0.0d0
precipstartdate1 = 0
precipstartdate2 = 0
precipperiod = 0.0d0
precipconst = 0.0d0
precip_exfremo_intercept = 0.0d0
precip_exfremo_slope = 0.0d0
snowprecipstartdate1 = 0
snowprecipstartdate2 = 0
snowprecipperiod = 0.0d0
snowprecipconst = 0.0d0
snowprecip_exfremo_intercept = 0.0d0
snowprecip_exfremo_slope = 0.0d0
runoffstartdate1 = 0
runoffstartdate2 = 0
runoffperiod = 0.0d0
runoffconst = 0.0d0
runoff_exfremo_intercept = 0.0d0
runoff_exfremo_slope = 0.0d0
ustressstartdate1 = 0
ustressstartdate2 = 0
ustressperiod = 0.0d0
ustressconst = 0.0d0
ustress_exfremo_intercept = 0.0d0
ustress_exfremo_slope = 0.0d0
vstressstartdate1 = 0
vstressstartdate2 = 0
vstressperiod = 0.0d0
vstressconst = 0.0d0
vstress_exfremo_intercept = 0.0d0
vstress_exfremo_slope = 0.0d0
uwindstartdate1 = 0
uwindstartdate2 = 0
uwindperiod = 0.0d0
uwindconst = 0.0d0
uwind_exfremo_intercept = 0.0d0
uwind_exfremo_slope = 0.0d0
vwindstartdate1 = 0
vwindstartdate2 = 0
vwindperiod = 0.0d0
vwindconst = 0.0d0
vwind_exfremo_intercept = 0.0d0
vwind_exfremo_slope = 0.0d0
wspeedstartdate1 = 0
wspeedstartdate2 = 0
wspeedperiod = 0.0d0
wspeedconst = 0.0d0
wspeed_exfremo_intercept = 0.0d0
wspeed_exfremo_slope = 0.0d0
swfluxstartdate1 = 0
swfluxstartdate2 = 0
swfluxperiod = 0.0d0
swfluxconst = 0.0d0
swflux_exfremo_intercept = 0.0d0
swflux_exfremo_slope = 0.0d0
lwfluxstartdate1 = 0
lwfluxstartdate2 = 0
lwfluxperiod = 0.0d0
lwfluxconst = 0.0d0
lwflux_exfremo_intercept = 0.0d0
lwflux_exfremo_slope = 0.0d0
swdownstartdate1 = 0
swdownstartdate2 = 0
swdownperiod = 0.0d0
swdownconst = 0.0d0
swdown_exfremo_intercept = 0.0d0
swdown_exfremo_slope = 0.0d0
lwdownstartdate1 = 0
lwdownstartdate2 = 0
lwdownperiod = 0.0d0
lwdownconst = 0.0d0
lwdown_exfremo_intercept = 0.0d0
lwdown_exfremo_slope = 0.0d0
apressurestartdate1 = 0
apressurestartdate2 = 0
apressureperiod = 0.0d0
apressureconst = 0.0d0
apressure_exfremo_intercept = 0.0d0
apressure_exfremo_slope = 0.0d0
climsststartdate1 = 0
climsststartdate2 = 0
climsstperiod = 0
climsstconst = 0.0d0
climsst_exfremo_intercept = 0.0d0
climsst_exfremo_slope = 0.0d0
climsssstartdate1 = 0
climsssstartdate2 = 0
climsssperiod = 0
climsssconst = 0.0d0
climsss_exfremo_intercept = 0.0d0
climsss_exfremo_slope = 0.0d0
obcsNstartdate1 = 0
obcsNstartdate2 = 0
obcsNperiod = 0.0d0
obcsSstartdate1 = 0
obcsSstartdate2 = 0
obcsSperiod = 0.0d0
obcsEstartdate1 = 0
obcsEstartdate2 = 0
obcsEperiod = 0.0d0
obcsWstartdate1 = 0
obcsWstartdate2 = 0
obcsWperiod = 0.0d0
siobNstartdate1 = UNSET_I
siobNstartdate2 = UNSET_I
siobNperiod = UNSET_RL
siobSstartdate1 = UNSET_I
siobSstartdate2 = UNSET_I
siobSperiod = UNSET_RL
siobEstartdate1 = UNSET_I
siobEstartdate2 = UNSET_I
siobEperiod = UNSET_RL
siobWstartdate1 = UNSET_I
siobWstartdate2 = UNSET_I
siobWperiod = UNSET_RL
repeatPeriod = 0.0d0
windstressmax = 2.0d0
exf_scal_BulkCdn = 1.0d0
c Initialise freezing temperature of sea water
climtempfreeze = -1.9d0
c Data files.
hfluxfile = ' '
atempfile = ' '
aqhfile = ' '
evapfile = ' '
precipfile = ' '
snowprecipfile = ' '
sfluxfile = ' '
runofffile = ' '
ustressfile = ' '
vstressfile = ' '
uwindfile = ' '
vwindfile = ' '
wspeedfile = ' '
swfluxfile = ' '
lwfluxfile = ' '
swdownfile = ' '
lwdownfile = ' '
apressurefile = ' '
climsstfile = ' '
climsssfile = ' '
c Start dates.
hfluxstartdate = 0.
atempstartdate = 0.
aqhstartdate = 0.
evapstartdate = 0.
precipstartdate = 0.
snowprecipstartdate= 0.
sfluxstartdate = 0.
runoffstartdate = 0.
ustressstartdate = 0.
vstressstartdate = 0.
uwindstartdate = 0.
vwindstartdate = 0.
wspeedstartdate = 0.
swfluxstartdate = 0.
lwfluxstartdate = 0.
swdownstartdate = 0.
lwdownstartdate = 0.
obcsNstartdate = 0.
obcsSstartdate = 0.
obcsEstartdate = 0.
obcsWstartdate = 0.
siobNstartdate = 0.
siobSstartdate = 0.
siobEstartdate = 0.
siobWstartdate = 0.
apressurestartdate = 0.
climsststartdate = 0.
climsssstartdate = 0.
c Initialise file type and field precision
exf_iprec = 32
exf_yftype = 'RL'
useExfYearlyFields = .FALSE.
twoDigitYear = .FALSE.
c Input scaling factors.
exf_inscal_hflux = 1.d0
exf_inscal_sflux = 1.d0
exf_inscal_ustress = 1.d0
exf_inscal_vstress = 1.d0
exf_inscal_uwind = 1.d0
exf_inscal_vwind = 1.d0
exf_inscal_wspeed = 1.d0
exf_inscal_swflux = 1.d0
exf_inscal_lwflux = 1.d0
exf_inscal_precip = 1.d0
exf_inscal_snowprecip= 1.d0
exf_inscal_sst = 1.d0
exf_inscal_sss = 1.d0
exf_inscal_atemp = 1.d0
exf_offset_atemp = 0.d0
exf_inscal_aqh = 1.d0
exf_inscal_evap = 1.d0
exf_inscal_apressure = 1.d0
exf_inscal_runoff = 1.d0
exf_inscal_swdown = 1.d0
exf_inscal_lwdown = 1.d0
exf_inscal_climsst = 1.d0
exf_inscal_climsss = 1.d0
c Output scaling factors.
exf_outscal_hflux = 1.d0
exf_outscal_sflux = 1.d0
exf_outscal_ustress = 1.d0
exf_outscal_vstress = 1.d0
exf_outscal_swflux = 1.d0
exf_outscal_sst = 1.d0
exf_outscal_sss = 1.d0
exf_outscal_apressure= 1.d0
ustress_lon0 = thetaMin
uwind_lon0 = thetaMin
vstress_lon0 = thetaMin + delX(1)*exf_half
hflux_lon0 = thetaMin + delX(1)*exf_half
sflux_lon0 = thetaMin + delX(1)*exf_half
swflux_lon0 = thetaMin + delX(1)*exf_half
runoff_lon0 = thetaMin + delX(1)*exf_half
atemp_lon0 = thetaMin + delX(1)*exf_half
aqh_lon0 = thetaMin + delX(1)*exf_half
evap_lon0 = thetaMin + delX(1)*exf_half
precip_lon0 = thetaMin + delX(1)*exf_half
snowprecip_lon0= thetaMin + delX(1)*exf_half
vwind_lon0 = thetaMin + delX(1)*exf_half
wspeed_lon0 = thetaMin + delX(1)*exf_half
lwflux_lon0 = thetaMin + delX(1)*exf_half
swdown_lon0 = thetaMin + delX(1)*exf_half
lwdown_lon0 = thetaMin + delX(1)*exf_half
apressure_lon0 = thetaMin + delX(1)*exf_half
vstress_lat0 = phimin
vwind_lat0 = phimin
wspeed_lat0 = phimin
ustress_lat0 = phimin + delY(1)*exf_half
hflux_lat0 = phimin + delY(1)*exf_half
sflux_lat0 = phimin + delY(1)*exf_half
runoff_lat0 = phimin + delY(1)*exf_half
swflux_lat0 = phimin + delY(1)*exf_half
atemp_lat0 = phimin + delY(1)*exf_half
aqh_lat0 = phimin + delY(1)*exf_half
evap_lat0 = phimin + delY(1)*exf_half
precip_lat0 = phimin + delY(1)*exf_half
snowprecip_lat0= phimin + delY(1)*exf_half
uwind_lat0 = phimin + delY(1)*exf_half
lwflux_lat0 = phimin + delY(1)*exf_half
swdown_lat0 = phimin + delY(1)*exf_half
lwdown_lat0 = phimin + delY(1)*exf_half
apressure_lat0 = phimin + delY(1)*exf_half
ustress_nlon = Nx
ustress_nlat = Ny
vstress_nlon = Nx
vstress_nlat = Ny
hflux_nlon = Nx
hflux_nlat = Ny
sflux_nlon = Nx
sflux_nlat = Ny
swflux_nlon = Nx
swflux_nlat = Ny
runoff_nlon = Nx
runoff_nlat = Ny
atemp_nlon = Nx
atemp_nlat = Ny
aqh_nlon = Nx
aqh_nlat = Ny
evap_nlon = Nx
evap_nlat = Ny
precip_nlon = Nx
snowprecip_nlon= Nx
precip_nlat = Ny
snowprecip_nlat= Ny
uwind_nlon = Nx
uwind_nlat = Ny
vwind_nlon = Nx
vwind_nlat = Ny
wspeed_nlon = Nx
wspeed_nlat = Ny
lwflux_nlon = Nx
lwflux_nlat = Ny
swdown_nlon = Nx
swdown_nlat = Ny
lwdown_nlon = Nx
lwdown_nlat = Ny
apressure_nlon = Nx
apressure_nlat = Ny
Ustress_lon_inc = delX(1)
vstress_lon_inc = delX(1)
hflux_lon_inc = delX(1)
sflux_lon_inc = delX(1)
swflux_lon_inc = delX(1)
runoff_lon_inc = delX(1)
atemp_lon_inc = delX(1)
aqh_lon_inc = delX(1)
evap_lon_inc = delX(1)
precip_lon_inc = delX(1)
snowprecip_lon_inc= delX(1)
uwind_lon_inc = delX(1)
vwind_lon_inc = delX(1)
wspeed_lon_inc = delX(1)
lwflux_lon_inc = delX(1)
swdown_lon_inc = delX(1)
lwdown_lon_inc = delX(1)
apressure_lon_inc = delX(1)
climsst_lon0 = thetaMin + delX(1)*exf_half
climsss_lon0 = thetaMin + delX(1)*exf_half
climsst_lat0 = phimin + delY(1)*exf_half
climsss_lat0 = phimin + delY(1)*exf_half
climsst_nlon = Nx
climsst_nlat = Ny
climsss_nlon = Nx
climsss_nlat = Ny
climsst_lon_inc = delX(1)
climsss_lon_inc = delX(1)
DO i=1,MAX_LAT_INC
IF (i.LT.Ny) THEN
vstress_lat_inc(i) = delY(i)
vwind_lat_inc(i) = delY(i)
wspeed_lat_inc(i) = delY(i)
ustress_lat_inc(i) = (delY(i) + delY(i))*exf_half
hflux_lat_inc(i) = (delY(i) + delY(i))*exf_half
sflux_lat_inc(i) = (delY(i) + delY(i))*exf_half
swflux_lat_inc(i) = (delY(i) + delY(i))*exf_half
runoff_lat_inc(i) = (delY(i) + delY(i))*exf_half
atemp_lat_inc(i) = (delY(i) + delY(i))*exf_half
aqh_lat_inc(i) = (delY(i) + delY(i))*exf_half
evap_lat_inc(i) = (delY(i) + delY(i))*exf_half
precip_lat_inc(i) = (delY(i) + delY(i))*exf_half
snowprecip_lat_inc(i)= (delY(i) + delY(i))*exf_half
uwind_lat_inc(i) = (delY(i) + delY(i))*exf_half
lwflux_lat_inc(i) = (delY(i) + delY(i))*exf_half
swdown_lat_inc(i) = (delY(i) + delY(i))*exf_half
lwdown_lat_inc(i) = (delY(i) + delY(i))*exf_half
apressure_lat_inc(i) = (delY(i) + delY(i))*exf_half
climsst_lat_inc(i) = (delY(i) + delY(i))*exf_half
climsss_lat_inc(i) = (delY(i) + delY(i))*exf_half
ELSE
ustress_lat_inc(i) = 0.
vstress_lat_inc(i) = 0.
hflux_lat_inc(i) = 0.
sflux_lat_inc(i) = 0.
swflux_lat_inc(i) = 0.
runoff_lat_inc(i) = 0.
atemp_lat_inc(i) = 0.
aqh_lat_inc(i) = 0.
evap_lat_inc(i) = 0.
precip_lat_inc(i) = 0.
snowprecip_lat_inc(i)= 0.
uwind_lat_inc(i) = 0.
vwind_lat_inc(i) = 0.
wspeed_lat_inc(i) = 0.
lwflux_lat_inc(i) = 0.
swdown_lat_inc(i) = 0.
lwdown_lat_inc(i) = 0.
apressure_lat_inc(i) = 0.
climsst_lat_inc(i) = 0.
climsss_lat_inc(i) = 0.
ENDIF
ENDDO
c Next, read the forcing data file.
WRITE(msgBuf,'(A)') 'EXF_READPARMS: opening data.exf'
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT , 1)
CALL OPEN_COPY_DATA_FILE(
I 'data.exf', 'EXF_READPARMS',
O iUnit,
I myThid )
WRITE(msgBuf,'(A)')
& 'EXF_READPARMS: reading EXF_NML_01'
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT , 1)
READ( iUnit, nml = EXF_NML_01 )
WRITE(msgBuf,'(A)')
& 'EXF_READPARMS: reading EXF_NML_02'
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT , 1)
READ( iUnit, nml = EXF_NML_02 )
WRITE(msgBuf,'(A)')
& 'EXF_READPARMS: reading EXF_NML_03'
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT , 1)
READ( iUnit, nml = EXF_NML_03 )
WRITE(msgBuf,'(A)')
& 'EXF_READPARMS: reading EXF_NML_04'
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT , 1)
READ( iUnit, nml = EXF_NML_04 )
WRITE(msgBuf,'(A)')
& 'EXF_READPARMS: reading EXF_NML_OBCS'
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT , 1)
READ( iUnit, nml = EXF_NML_OBCS )
IF(siobNstartdate1.EQ.UNSET_I ) siobNstartdate1 = obcsNstartdate1
IF(siobNstartdate2.EQ.UNSET_I ) siobNstartdate2 = obcsNstartdate2
IF(siobNperiod .EQ.UNSET_RL) siobNperiod = obcsNperiod
IF(siobSstartdate1.EQ.UNSET_I ) siobSstartdate1 = obcsSstartdate1
IF(siobSstartdate2.EQ.UNSET_I ) siobSstartdate2 = obcsSstartdate2
IF(siobSperiod .EQ.UNSET_RL) siobSperiod = obcsSperiod
IF(siobEstartdate1.EQ.UNSET_I ) siobEstartdate1 = obcsEstartdate1
IF(siobEstartdate2.EQ.UNSET_I ) siobEstartdate2 = obcsEstartdate2
IF(siobEperiod .EQ.UNSET_RL) siobEperiod = obcsEperiod
IF(siobWstartdate1.EQ.UNSET_I ) siobWstartdate1 = obcsWstartdate1
IF(siobWstartdate2.EQ.UNSET_I ) siobWstartdate2 = obcsWstartdate2
IF(siobWperiod .EQ.UNSET_RL) siobWperiod = obcsWperiod
WRITE(msgBuf,'(A)')
& 'EXF_READPARMS: finished reading data.exf'
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT , 1)
CLOSE( iUnit )
C-- Derive other parameters:
hq = ht
stressIsOnCgrid = .FALSE.
CALL EXF_CHECK( myThid )
c Complete the start date specifications for the forcing
c fields to get a complete calendar date array.
C => moved to EXF_INIT_FIXED
ENDIF
CALL BARRIER(myThid)
RETURN
END