/[MITgcm]/MITgcm/pkg/exf/EXF_OPTIONS.h

Diff of /MITgcm/pkg/exf/EXF_OPTIONS.h

Parent Directory | Revision Log | View Revision Graph Revision Graph | View Patch Patch

-revision 1.21 by jmc,
Sun Dec 25 22:26:15 2011 UTC
+revision 1.30 by jmc,
Fri May  2 22:14:52 2014 UTC
 Line 1
  C $Header$
  C $Name$
+ CBOP
+ C !ROUTINE: EXF_OPTIONS.h
+ C !INTERFACE:
+ C #include "EXF_OPTIONS.h"
+ C !DESCRIPTION:
+ C *==================================================================*
+ C | CPP options file for EXternal Forcing (EXF) package:
+ C | Control which optional features to compile in this package code.
+ C *==================================================================*
+ CEOP
  #ifndef EXF_OPTIONS_H
  #define EXF_OPTIONS_H
  #include "PACKAGES_CONFIG.h"
- #include "AD_CONFIG.h"
  #include "CPP_OPTIONS.h"
  #ifdef ALLOW_EXF
- C     Package-specific Options & Macros go here
+ #ifdef ECCO_CPPOPTIONS_H
- #ifdef ALLOW_AUTODIFF_TAMC
- C When compile for AD mode,
+ C-- When multi-package option-file ECCO_CPPOPTIONS.h is used (directly included
- C this package is currently configured by ECCO_CPPOPTIONS.h
+ C    in CPP_OPTIONS.h), this option file is left empty since all options that
- C which is directly included in CPP_OPTIONS.h
+ C   are specific to this package are assumed to be set in ECCO_CPPOPTIONS.h
- #else /* ndef ALLOW_AUTODIFF_TAMC */
+ #else /* ndef ECCO_CPPOPTIONS_H */
- C CPP flags controlling which code is included in the files that
+ C-- Package-specific Options & Macros go here
- C will be compiled.
+ C   pkg/exf CPP options:
- c   pkg/exf CPP options:
+ C   --------------------
- c   --------------------
+ C
- c
+ C   > ( EXF_VERBOSE ) < replaced with run-time, logical parameter "exf_verbose".
- c   > ( EXF_VERBOSE ) < replaced with run-time, logical parameter "exf_verbose".
+ C
- c
+ C   >>> ALLOW_ATM_WIND <<<
- c   >>> ALLOW_ATM_WIND <<<
+ C       If defined, 10-m wind fields can be read-in from files.
- c       If defined, 10-m wind fields can be read-in from files.
+ C
- c
+ C   >>> ALLOW_ATM_TEMP <<<
- c   >>> ALLOW_ATM_TEMP <<<
+ C       If defined, atmospheric temperature and specific
- c       If defined, atmospheric temperature and specific
+ C       humidity fields can be read-in from files.
- c       humidity fields can be read-in from files.
+ C
- c
+ C   >>> ALLOW_DOWNWARD_RADIATION <<<
- c   >>> ALLOW_DOWNWARD_RADIATION <<<
+ C       If defined, downward long-wave and short-wave 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       can be read-in form files or computed from lwflux and swflux.
+ C
- c
+ C   >>> ALLOW_ZENITHANGLE <<<
- c   >>> ALLOW_ZENITHANGLE <<<
+ C       If defined, ocean albedo varies with the zenith angle, and
- c       If defined, ocean albedo varies with the zenith angle, and
+ C       incoming fluxes at the top of the atmosphere are computed
- c       incoming fluxes at the top of the atmosphere are computed
+ C
- c
+ C   >>> ALLOW_BULKFORMULAE <<<
- c   >>> ALLOW_BULKFORMULAE <<<
+ C       Allows the use of bulk formulae in order to estimate
- c       Allows the use of bulk formulae in order to estimate
+ C       turbulent and radiative fluxes at the ocean surface.
- c       turbulent and radiative fluxes at the ocean surface.
+ C
- c
+ C   >>> EXF_READ_EVAP <<<
- c   >>> EXF_READ_EVAP <<<
+ C       If defined, evaporation fields are read-in, rather than
- c       If defined, evaporation fields are read-in, rather than
+ C       computed from atmospheric state.
- c       computed from atmospheric state.
+ C
- c
+ C   >>> ALLOW_RUNOFF <<<
- c   >>> ALLOW_RUNOFF <<<
+ C       If defined, river and glacier runoff can be read-in from files.
- c       If defined, river and glacier runoff can be read-in from files.
+ C
- c
+ C   >>> ALLOW_RUNOFTEMP <<<
- c   >>> ATMOSPHERIC_LOADING <<<
+ C       If defined, river and glacier runoff temperature
- c       If defined, atmospheric pressure can be read-in from files.
+ C       can be read-in from files.
- c   WARNING: this flag is set (define/undef) in CPP_OPTIONS.h
+ C
- c            and cannot be changed here (in EXF_OPTIONS)
+ C   >>> ATMOSPHERIC_LOADING <<<
- c
+ C       If defined, atmospheric pressure can be read-in from files.
- c   >>> ICE_AREAMASK <<<
+ C   WARNING: this flag is set (define/undef) in CPP_OPTIONS.h
- c       If defined, fractional ice-covered area MASK can be read-in from files.
+ C            and cannot be changed here (in EXF_OPTIONS)
- c
+ C
- c   >>> ALLOW_CLIMSST_RELAXATION <<<
+ C   >>> EXF_SEAICE_FRACTION <<<
- c       Allow the relaxation to a monthly climatology of sea surface
+ C       If defined, seaice fraction can be read-in from files (areaMaskFile)
- c       temperature, e.g. the Reynolds climatology.
+ C
- c
+ C   >>> ALLOW_CLIMSST_RELAXATION <<<
- c   >>> ALLOW_CLIMSSS_RELAXATION <<<
+ C       Allow the relaxation to a monthly climatology of sea surface
- c       Allow the relaxation to a monthly climatology of sea surface
+ C       temperature, e.g. the Reynolds climatology.
- c       salinity, e.g. the Levitus climatology.
+ C
- c
+ C   >>> ALLOW_CLIMSSS_RELAXATION <<<
- c   >>> USE_EXF_INTERPOLATION <<<
+ C       Allow the relaxation to a monthly climatology of sea surface
- c       Allows specification of arbitrary Cartesian input grids.
+ C       salinity, e.g. the Levitus climatology.
- c
+ C
- c   ====================================================================
+ C   >>> USE_EXF_INTERPOLATION <<<
- c
+ C       Allows specification of arbitrary Cartesian input grids.
- c       The following CPP options:
+ C
- c
+ C   >>> EXF_CALC_ATMRHO
- c          ALLOW_ATM_WIND              (WIND)
+ C       Calculate the local atm density as function of temp, humidity
- c          ALLOW_ATM_TEMP              (TEMP)
+ C       and pressure
- c          ALLOW_DOWNWARD_RADIATION    (DOWN)
+ C
- c          ALLOW_BULKFORMULAE          (BULK)
+ C   ====================================================================
- c          EXF_READ_EVAP               (EVAP)
+ C
- c
+ C       The following CPP options:
- c       permit the ocean-model forcing configurations listed in the
+ C
- c       table below.  The first configuration is the default,
+ C          ALLOW_ATM_WIND              (WIND)
- c       flux-forced, ocean model.  The next four are stand-alone
+ C          ALLOW_ATM_TEMP              (TEMP)
- c       configurations that use pkg/exf, open-water bulk formulae to
+ C          ALLOW_DOWNWARD_RADIATION    (DOWN)
- c       compute the missing surface fluxes from atmospheric variables.
+ C          ALLOW_BULKFORMULAE          (BULK)
- c       The last four configurations can be used in conjunction with
+ C          EXF_READ_EVAP               (EVAP)
- c       pkg/seaice to model ice-covered regions.  The forcing fields
+ C
- c       in the rightmost column are defined in exf_fields.
+ C       permit the ocean-model forcing configurations listed in the
- c
+ C       table below.  The first configuration is the default,
- c
+ C       flux-forced, ocean model.  The next four are stand-alone
- c    WIND |TEMP |DOWN |BULK |EVAP |            actions
+ C       configurations that use pkg/exf, open-water bulk formulae to
- c    -----|-----|-----|-----|-----|-------------------------------------
+ C       compute the missing surface fluxes from atmospheric variables.
- c         |     |     |     |     |
+ C       The last four configurations can be used in conjunction with
- c      -  |  -  |  -  |  -  |  -  | Read-in ustress, vstress, hflux,
+ C       pkg/seaice to model ice-covered regions.  The forcing fields
- c         |     |     |     |     | swflux, and sflux.
+ C       in the rightmost column are defined in exf_fields.
- c         |     |     |     |     |
+ C
- c     def | def | def | def |  -  | Read-in uwind, vwind, atemp, aqh,
+ C
- c         |     |     |     |     | swdown, lwdown, precip, and runoff.
+ C    WIND |TEMP |DOWN |BULK |EVAP |            actions
- c         |     |     |     |     | Compute ustress, vstress, hflux,
+ C    -----|-----|-----|-----|-----|-------------------------------------
- c         |     |     |     |     | swflux, and sflux.
+ C         |     |     |     |     |
- c         |     |     |     |     |
+ C      -  |  -  |  -  |  -  |  -  | Read-in ustress, vstress, hflux,
- c     def | def |  -  | def |  -  | Read-in uwind, vwind, atemp, aqh,
+ C         |     |     |     |     | swflux, and sflux.
- c         |     |     |     |     | swflux, lwflux, precip, and runoff.
+ C         |     |     |     |     |
- c         |     |     |     |     | Compute ustress, vstress, hflux,
+ C     def | def | def | def |  -  | Read-in uwind, vwind, atemp, aqh,
- c         |     |     |     |     | and sflux.
+ C         |     |     |     |     | swdown, lwdown, precip, and runoff.
- c         |     |     |     |     |
+ C         |     |     |     |     | Compute ustress, vstress, hflux,
- c     def |  -  |  -  | def |  -  | Read-in uwind, vwind, hflux,
+ C         |     |     |     |     | swflux, and sflux.
- c         |     |     |     |     | swflux, and sflux.
+ C         |     |     |     |     |
- c         |     |     |     |     | Compute ustress and vstress.
+ C     def | def |  -  | def |  -  | Read-in uwind, vwind, atemp, aqh,
- c         |     |     |     |     |
+ C         |     |     |     |     | swflux, lwflux, precip, and runoff.
- c      -  | def |  -  | def |  -  | Read-in ustress, vstress, atemp,
+ C         |     |     |     |     | Compute ustress, vstress, hflux,
- c         |     |     |     |     | aqh, swflux, lwflux, precip, and
+ C         |     |     |     |     | and sflux.
- c         |     |     |     |     | runoff.  Compute hflux and sflux.
+ C         |     |     |     |     |
- c         |     |     |     |     |
+ C     def |  -  |  -  | def |  -  | Read-in uwind, vwind, hflux,
- c     def | def |  -  |  -  | def | Read-in uwind, vwind, atemp, aqh,
+ C         |     |     |     |     | swflux, and sflux.
- c         |     |     |     |     | swflux, lwflux, precip, runoff,
+ C         |     |     |     |     | Compute ustress and vstress.
- c         |     |     |     |     | and evap.
+ C         |     |     |     |     |
- c         |     |     |     |     |
+ C      -  | def |  -  | def |  -  | Read-in ustress, vstress, atemp,
- c     def | def |  -  | def |  -  | Read-in uwind, vwind, atemp, aqh,
+ C         |     |     |     |     | aqh, swflux, lwflux, precip, and
- c         |     |     |     |     | swflux, lwflux, precip, and runoff.
+ C         |     |     |     |     | runoff.  Compute hflux and sflux.
- c         |     |     |     |     | Compute open-water ustress, vstress,
+ C         |     |     |     |     |
- c         |     |     |     |     | hflux, swflux, and evap.
+ C     def | def |  -  |  -  | def | Read-in uwind, vwind, atemp, aqh,
- c         |     |     |     |     |
+ C         |     |     |     |     | swflux, lwflux, precip, runoff,
- c     def | def | def |  -  | def | Read-in uwind, vwind, atemp, aqh,
+ C         |     |     |     |     | and evap.
- c         |     |     |     |     | swdown, lwdown, precip, runoff,
+ C         |     |     |     |     |
- c         |     |     |     |     | and evap.
+ C     def | def |  -  | def |  -  | Read-in uwind, vwind, atemp, aqh,
- c         |     |     |     |     |
+ C         |     |     |     |     | swflux, lwflux, precip, and runoff.
- c     def | def | def | def |  -  | Read-in uwind, vwind, atemp, aqh,
+ C         |     |     |     |     | Compute open-water ustress, vstress,
- c         |     |     |     |     | swdown, lwdown, precip, and runoff.
+ C         |     |     |     |     | hflux, swflux, and evap.
- c         |     |     |     |     | Compute open-water ustress, vstress,
+ C         |     |     |     |     |
- c         |     |     |     |     | hflux, swflux, and evap.
+ C     def | def | def |  -  | def | Read-in uwind, vwind, atemp, aqh,
- c
+ C         |     |     |     |     | swdown, lwdown, precip, runoff,
- c   ====================================================================
+ 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   Bulk formulae related flags.
  #define  ALLOW_ATM_TEMP
  #define  ALLOW_ATM_WIND
  #define  ALLOW_DOWNWARD_RADIATION
  #define  ALLOW_RUNOFF
+ #undef   ALLOW_RUNOFTEMP
  #if (defined (ALLOW_ATM_TEMP) || defined (ALLOW_ATM_WIND))
  # define ALLOW_BULKFORMULAE
- # undef ALLOW_BULK_LARGEYEAGER04
+ # undef  ALLOW_BULK_LARGEYEAGER04
+ #endif
+ #if (defined (ALLOW_ATM_TEMP) && defined (ATMOSPHERIC_LOADING))
+ # undef  EXF_CALC_ATMRHO
  #endif
  C   Zenith Angle/Albedo related flags.
-Line 150 
 C   Zenith Angle/Albedo related flags.
+Line 170 
 C   Zenith Angle/Albedo related flags.
  # undef ALLOW_ZENITHANGLE
  #endif
- C   Use ocean_emissivity*lwdwon in lwFlux. This flag should always be define
+ C   Use ocean_emissivity*lwdown in lwFlux. This flag should be defined
- C   but is not because of backward compatibility
+ C   unless to reproduce old results (obtained with inconsistent old code)
  #ifdef ALLOW_DOWNWARD_RADIATION
- # undef EXF_LWDOWN_WITH_EMISSIVITY
+ # define EXF_LWDOWN_WITH_EMISSIVITY
  #endif
  C   Relaxation to monthly climatologies.
  #define ALLOW_CLIMSST_RELAXATION
  #define ALLOW_CLIMSSS_RELAXATION
+ C   Allows to read-in seaice fraction from files (areaMaskFile)
+ #undef EXF_SEAICE_FRACTION
  C   Use spatial interpolation to interpolate
  C   forcing files from input grid to model grid.
  #undef USE_EXF_INTERPOLATION
  C   for interpolated vector fields, rotate towards model-grid axis
  C   using old rotation formulae (instead of grid-angles)
  #undef EXF_USE_OLD_VEC_ROTATION
+ C   for interpolation around N & S pole, use the old formulation
+ C   (no pole symmetry, single vector-comp interp, reset to 0 zonal-comp @ N.pole)
+ #undef EXF_USE_OLD_INTERP_POLE
  #define EXF_INTERP_USE_DYNALLOC
  #if ( defined (EXF_INTERP_USE_DYNALLOC) && defined (USING_THREADS) )
  # define EXF_IREAD_USE_GLOBAL_POINTER
  #endif
- #endif /* ndef ALLOW_AUTODIFF_TAMC */
+ #endif /* ndef ECCO_CPPOPTIONS_H */
  #endif /* ALLOW_EXF */
  #endif /* EXF_OPTIONS_H */

 Legend:



Removed from v.1.21
 


changed lines


 
Added in v.1.30
 Legend:



Removed from v.1.21
 


changed lines


 
Added in v.1.30
-Removed from v.1.21
+Added in v.1.30

	ViewVC Help
Powered by ViewVC 1.1.22