pkg/ecco/ECCO_OPTIONS.h

5f7bb52e52 Jean*0001 #ifndef ECCO_OPTIONS_H
                0002 #define ECCO_OPTIONS_H
                0003 #include "PACKAGES_CONFIG.h"
                0004 #include "CPP_OPTIONS.h"
                0005
75ec70d09f Jean*0006 CBOP
                0007 C !ROUTINE: ECCO_OPTIONS.h
                0008 C !INTERFACE:
                0009 C #include "ECCO_OPTIONS.h"
                0010
                0011 C !DESCRIPTION:
                0012 C *==================================================================*
                0013 C | CPP options file for ECCO (ecco) package:
                0014 C | Control which optional features to compile in this package code.
                0015 C *==================================================================*
                0016 CEOP
                0017
                0018 #ifdef ALLOW_ECCO
                0019 #ifdef ECCO_CPPOPTIONS_H
                0020
                0021 C-- When multi-package option-file ECCO_CPPOPTIONS.h is used (directly included
                0022 C    in CPP_OPTIONS.h), this option file is left empty since all options that
                0023 C   are specific to this package are assumed to be set in ECCO_CPPOPTIONS.h
                0024
                0025 #else /* ndef ECCO_CPPOPTIONS_H */
38e5603567 Gael*0026
75ec70d09f Jean*0027 C-- Package-specific Options & Macros go here
                0028
f40bb882f5 Jean*0029 C o Allow for generic cost function and integral terms with pkg/ecco:
38e5603567 Gael*0030 #define ALLOW_GENCOST_CONTRIBUTION
f40bb882f5 Jean*0031 C o Allow for 3 dimensional generic cost terms with pkg/ecco:
38e5603567 Gael*0032 #define ALLOW_GENCOST3D
f40bb882f5 Jean*0033 C   Note regarding GENCOST usage:
                0034 C   > In data.ecco, this requires the specification of data file (name,
                0035 C     frequency, etc.), bar file name for corresp. model average, standard
                0036 C     error file name, etc.
                0037 C   > In addition, adding such cost terms requires editing ECCO_SIZE.h to
                0038 C     increase NGENCOST/NGENCOST3D, and editing cost_gencost_customize.F to
                0039 C     implement the actual model average (i.e. the bar file content).
                0040 # undef ALLOW_GENCOST_1D
                0041 # undef ALLOW_GENCOST_SSTV4_OUTPUT
38e5603567 Gael*0042
35c4fdc74b Emma*0043 C o Use total time-varying volume to weight contributions, if defined
                0044 #undef ECCO_VARIABLE_AREAVOLGLOB
                0045
5f7bb52e52 Jean*0046 C o Include global mean steric sea level correction
38e5603567 Gael*0047 #undef ALLOW_PSBAR_STERIC
13d362b8c1 Ou W*0048 #ifdef ATMOSPHERIC_LOADING
5a54dbbd56 Jean*0049 C   Apply inverse barometer correction (coded within ATMOSPHERIC_LOADING)
                0050 # undef ALLOW_IB_CORR
13d362b8c1 Ou W*0051 #endif
35c4fdc74b Emma*0052
5f7bb52e52 Jean*0053 C o Allow for near-shore and high-latitude altimetry
38e5603567 Gael*0054 #undef ALLOW_SHALLOW_ALTIMETRY
                0055 #undef ALLOW_HIGHLAT_ALTIMETRY
                0056
5f7bb52e52 Jean*0057 C o Cost function output format
38e5603567 Gael*0058 #undef ALLOW_ECCO_OLD_FC_PRINT
                0059
f40bb882f5 Jean*0060 C o Generate more text in STDOUT
75ec70d09f Jean*0061 #undef ECCO_VERBOSE
f40bb882f5 Jean*0062 #undef ALLOW_ECCO_DEBUG
                0063
                0064 C-- partially retired options (i.e., only used to set default switch):
                0065 # undef ALLOW_SSH_COST_CONTRIBUTION
                0066 # undef ALLOW_SST_COST_CONTRIBUTION
                0067 # undef ALLOW_SEAICE_COST_CONTRIBUTION
38e5603567 Gael*0068
75ec70d09f Jean*0069 C   ==================================================================
                0070 #endif /* ndef ECCO_CPPOPTIONS_H */
                0071 #endif /* ALLOW_ECCO */
                0072 #endif /* ECCO_OPTIONS_H */