Warning, /doc/examples/cfc_offline/cfc_offline.rst is written in an unsupported language. File is not indexed.
view on githubraw file Latest commit 08815fc8 on 2020-12-16 23:58:51 UTC
d67096e55c Jeff*0001 .. _sec_eg_offline_cfc:
0002
0003 Offline Experiments
0004 ===================
0005
0006 (in directory: :filelink:`verification/tutorial_cfc_offline/`)
0007
0008 This document describes two experiments using the offline form of
0009 the MITgcm.
0010
0011 Overview
0012 --------
0013
0014 The first experiment demonstrates use of the offline form of the MITgcm to
0015 study advection of a passive tracer. Time-averaged flow-fields and
0016 mixing coefficients, deriving from a prior online run, are re-used
0017 leaving only the tracer equation to be integrated. This first experiment's
0018 run configuration is specified in directory :filelink:`verification/tutorial_cfc_offline/input_tutorial`.
0019
0020 Figure *— missing figure —* shows a movie of tracer being advected using
0021 the offline package of the MITgcm. In the top panel the frames of the
0022 movie show the monthly surface evolution of an initially local source of
0023 passive tracer. In the lower panel, the frames of the movie show the
0024 changing monthly surface evolution where the initial tracer field had a
0025 global distribution.
0026
0027 The second experiment, a more complicated example exploring contamination of the global ocean
0028 through surface exposure to CFCs during the last century, is described after this more simple first example.
0029 The run configuration for this second experiment is specified in directory :filelink:`verification/tutorial_cfc_offline/input`.
0030
0031 Time-stepping of tracers
0032 ------------------------
0033
0034 See :numref:`tracer_eqns` and :numref:`advection_schemes` for details of available tracer
0035 time-stepping schemes and their characteristics.
0036
0037 Code Configuration
0038 ------------------
0039
0040 The experiment files
0041
0042 - :filelink:`verification/tutorial_cfc_offline/input_tutorial/data`
0043
0044 - :filelink:`verification/tutorial_cfc_offline/input_tutorial/data.off`
0045
0046 - :filelink:`verification/tutorial_cfc_offline/input_tutorial/data.pkg`
0047
0048 - :filelink:`verification/tutorial_cfc_offline/input_tutorial/data.ptracers`
0049
0050 - :filelink:`verification/tutorial_cfc_offline/input_tutorial/eedata`
0051
0052 - :filelink:`verification/tutorial_cfc_offline/code/packages.conf`
0053
0054 - :filelink:`verification/tutorial_cfc_offline/code/PTRACERS_SIZE.h`
0055
0056 - :filelink:`verification/tutorial_cfc_offline/code/GMREDI_OPTIONS.h`
0057
0058 - :filelink:`verification/tutorial_cfc_offline/code/SIZE.h`
0059
0060 contain the code customizations and parameter settings required to run
0061 the example. In addition the following binary data files are required:
0062
0063 - ``input/depth_g77.bin``
0064
0065 - ``pickup_ptracers.0004269600``, ``pickup_ptracers.0004269600.meta``
0066
0067 - binary files in :filelink:`verification/tutorial_cfc_offline/input/input_off`
0068
0069 File :filelink:`input_tutorial/data <verification/tutorial_cfc_offline/input_tutorial/data>`
0070 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0071
0072 .. literalinclude:: ../../../verification/tutorial_cfc_offline/input_tutorial/data
0073 :linenos:
0074 :caption: verification/tutorial_cfc_offline/input_tutorial/data
0075
0076 This file specifies the main parameters
0077 for the experiment.
0078
0079 - Lines 18-19,
0080
0081 ::
0082
0083 nIter0 = 4269600,
0084 nTimeSteps = 4,
0085
0086 :varlink:`nIter0` and :varlink:`nTimesteps` control the start time and the length of the run
0087 (in timesteps). Given at :varlink:`nIter0` is non-zero, the model requires appropriate
0088 pickup files to be present in the run directory. For testing purposes, the model has been
0089 prescribed to run for 4 timesteps; for a longer run, increase :varlink:`nTimesteps`.
0090
0091 - Line 20,
0092
0093 ::
0094
0095 deltaTtracer= 43200.0,
0096
0097 :varlink:`deltaTtracer` is the tracer timestep in seconds, in this case, 12 hours
0098 (43200 seconds = 12 hours). Note that :varlink:`deltatTracer` must be specified in
0099 :filelink:`input_tutorial/data <verification/tutorial_cfc_offline/input_tutorial/data>` as well as
0100 specified in :varlink:`deltaToffline` in :filelink:`input_tutorial/data.off <verification/tutorial_cfc_offline/input_tutorial/data.off>`.
0101
0102 - Line 21,
0103
0104 ::
0105
0106 deltaTClock= 43200.0,
0107
0108 When using the MITgcm in offline mode, :varlink:`deltaTClock` (an internal model
0109 counter) should be made equal to the value assigned to :varlink:`deltatTtracer`.
0110
0111 - Line 27,
0112
0113 ::
0114
0115 periodicExternalForcing=.TRUE.,
0116
0117 :varlink:`periodicExternalForcing` is a flag telling the model whether to
0118 cyclically re-use forcing data where there is external forcing
0119 (see :numref:`tut_offline_example2` below). Where there is no external forcing, as
0120 here, but where there is to be cyclic re-use of the offline flow and
0121 mixing fields, :varlink:`periodicExternalForcing` must be assigned the value ``.TRUE.``.
0122
0123 - Line 28,
0124
0125 ::
0126
0127 externForcingPeriod=2592000.,
0128
0129 :varlink:`externForcingPeriod` specifies the period of the external forcing data in
0130 seconds. In the absence of external forcing, as in this example, it must
0131 be made equal to the value of :varlink:`externForcingPeriod` in
0132 :filelink:`input_tutorial/data.off <verification/tutorial_cfc_offline/input_tutorial/data.off>`,
0133 in this case, monthly (2592000 seconds = 1 month).
0134
0135 - Line 29,
0136
0137 ::
0138
0139 externForcingCycle=31104000.,
0140
0141 :varlink:`externForcingCycle` specifies the duration of the external forcing data
0142 cycle in seconds. In the absence of external forcing, as in this
0143 example, it must be made equal to the value of :varlink:`externForcingCycle` in
0144 :filelink:`input_tutorial/data.off <verification/tutorial_cfc_offline/input_tutorial/data.off>`,
0145 in this case, the cycle is one year (31104000 seconds = 1 year).
0146
0147 - Line34,
0148
0149 ::
0150
0151 usingSphericalPolarGrid=.TRUE.,
0152
0153 This line requests that the simulation be performed in a spherical polar
0154 coordinate system. It affects the interpretation of grid input
0155 parameters and causes the grid generation routines to initialize an
0156 internal grid based on spherical polar geometry.
0157
0158 - Lines 35-37,
0159
0160 ::
0161
0162 delR= 50., 70., 100., 140., 190.,
0163 240., 290., 340., 390., 440.,
0164 490., 540., 590., 640., 690.,
0165
0166 This line sets the vertical grid spacing between each :math:`z`-coordinate line
0167 in the discrete grid. Here the total model depth is 5200 m.
0168
0169 - Line 38,
0170
0171 ::
0172
0173 ygOrigin=-90.,
0174
0175 This line sets the southern boundary of the modeled domain to
0176 -90\ :sup:`o` latitude N (= 90\ :sup:`o`\ S). This value
0177 affects both the generation of the locally orthogonal grid that the
0178 model uses internally and affects the initialization of the Coriolis
0179 force. Note: it is not required to set a longitude boundary, since the
0180 absolute longitude does not alter the kernel equation discretization.
0181
0182 - Line 39,
0183
0184 ::
0185
0186 dxSpacing=2.8125,
0187
0188 This line sets the horizontal grid spacing between each :math:`y`-coordinate
0189 line in the discrete grid to 2.8125\ :sup:`o` in longitude.
0190
0191 - Line 40,
0192
0193 ::
0194
0195 dySpacing=2.8125,
0196
0197 This line sets the vertical grid spacing between each :math:`x`-coordinate line
0198 in the discrete grid to 2.8125\ :sup:`o` in latitude.
0199
0200 - Line 45,
0201
0202 ::
0203
0204 bathyFile='depth_g77.bin',
0205
0206 This line specifies the name of the file
0207 from which the domain bathymetry is read. This file contains a
0208 2-D (:math:`x,y`) map of (assumed 64-bit) binary numbers
0209 giving the depth of the model at each grid cell, ordered with the :math:`x`
0210 coordinate varying fastest. The points are ordered from low coordinate
0211 to high coordinate for both axes. The units and orientation of the
0212 depths in this file are the same as used in the MITgcm code. In this
0213 experiment, a depth of 0 m indicates land.
0214
0215 File :filelink:`input_tutorial/data.off <verification/tutorial_cfc_offline/input_tutorial/data.off>`
0216 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0217
0218 .. literalinclude:: ../../../verification/tutorial_cfc_offline/input_tutorial/data.off
0219 :linenos:
0220 :caption: verification/tutorial_cfc_offline/input_tutorial/data.off
0221
0222 :filelink:`input_tutorial/data.off <verification/tutorial_cfc_offline/input_tutorial/data.off>`
0223 provides the MITgcm offline package with package
0224 specific parameters. Specifically, it contains the location (relative
0225 to the run directory) and prefix of files describing the flow field
0226 (:varlink:`UvelFile`, :varlink:`VvelFile`, :varlink:`WvelFile`) and the corresponding convective mixing
0227 coefficients (:varlink:`ConvFile`) which together prescribe the 3-D,
0228 time varying dynamic system within which the offline model will advect
0229 the tracer.
0230
0231 - Lines 2-4,8
0232
0233 ::
0234
0235 UvelFile= '../input/input_off/uVeltave',
0236 VvelFile= '../input/input_off/vVeltave',
0237 WvelFile= '../input/input_off/wVeltave',
0238 ConvFile= '../input/input_off/Convtave',
0239
0240 In the example the offline data is located in the sub-directory
0241 :filelink:`verification/tutorial_cfc_offline/input/input_off`.
0242 In this directory are fields describing the velocity
0243 and convective mixing histories of a prior forward integration of the
0244 MITgcm, required for the offline package. Based on the values of :varlink:`deltaToffline`,
0245 :varlink:`offlineForcingPeriod` and :varlink:`offlineForcingCycle` specified in
0246 :filelink:`verification/tutorial_cfc_offline/input/input_off`,
0247 since :varlink:`offlineForcingCycle` corresponds to twelve forcing
0248 periods :varlink:`offlineForcingPeriod` and since :varlink:`offlineIter0` is zero, there
0249 needs to be twelve :varlink:`uVeltave`, twelve :varlink:`vVeltave`, twelve :varlink:`wVeltave` and twelve ``Convtave`` files
0250 each having a 10 digit sequence identifier between 0000000001 to
0251 0000000012, that is, a total of 48 files.
0252
0253 - Line 12,
0254
0255 ::
0256
0257 offlineIter0=4248000,
0258
0259 :varlink:`offlineIter0`, here specified to be 4248000 timesteps, corresponds to the
0260 timestep at which the tracer model is initialized. Note that
0261 :varlink:`offlineIter0` and :varlink:`nIter0` (set in
0262 :filelink:`input_tutorial/data <verification/tutorial_cfc_offline/input_tutorial/data>`)
0263 need not be the same.
0264
0265 - Line 13,
0266
0267 ::
0268
0269 deltaToffline=43200.,
0270
0271 :varlink:`deltatToffline` sets the timestep associated with the offline model data
0272 in seconds, here 12 hours (43200 seconds = 12 hours).
0273
0274 - Line 14,
0275
0276 ::
0277
0278 offlineForcingPeriod=43200.,
0279
0280 :varlink:`offlineForcingPeriod` sets the forcing period associated with the offline
0281 model data in seconds.
0282
0283 - Line 15,
0284
0285 ::
0286
0287 offlineForcingCycle=518400.,
0288
0289 :varlink:`offlineForcingCycle` sets the forcing cycle length associated with the
0290 offline model data in seconds. In this example the offline forcing cycle
0291 is 6 days, or twelve offline forcing periods. Together :varlink:`deltatToffline`,
0292 :varlink:`offlineForcingPeriod` and :varlink:`offlineForcingCycle` determine the value of the
0293 ten digit sequencing tag the model expects files in
0294 :filelink:`input_tutorial/data.off <verification/tutorial_cfc_offline/input_tutorial/data.off>`
0295 to have.
0296
0297 File :filelink:`input_tutorial/data.pkg <verification/tutorial_cfc_offline/input_tutorial/data.pkg>`
0298 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0299
0300 .. literalinclude:: ../../../verification/tutorial_cfc_offline/input_tutorial/data.pkg
0301 :linenos:
0302 :caption: verification/tutorial_cfc_offline/input_tutorial/data.pkg
0303
0304 This file specifies which
0305 MITgcm packages are to be used.
0306
0307 - Line 4,
0308
0309 ::
0310
0311 usePTRACERS=.TRUE.,
0312
0313 :varlink:`usePTRACERS` is a flag invoking :filelink:`pkg/ptracers` which is responsible
0314 for the advection of the tracer within the model.
0315
0316 File :filelink:`input_tutorial/data.ptracers <verification/tutorial_cfc_offline/input_tutorial/data.ptracers>`
0317 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0318
0319 .. literalinclude:: ../../../verification/tutorial_cfc_offline/input_tutorial/data.ptracers
0320 :linenos:
0321 :caption: verification/tutorial_cfc_offline/input_tutorial/data.ptracers
0322
0323 This file provides the
0324 MITgcm ptracers package with package specific parameters, prescribing
0325 the nature of the the tracer/tracers as well as the variables associated
0326 with their advection.
0327
0328 - Line 2,
0329
0330 ::
0331
0332 PTRACERS_numInUse=2,
0333
0334 :varlink:`PTRACERS_numInUse` tells the model how many separate tracers are to be
0335 advected, in this case 2. Note: The value of :varlink:`PTRACERS_numInUse` must
0336 agree with the value specified in :filelink:`code/PTRACERS_SIZE.h <verification/tutorial_cfc_offline/code/PTRACERS_SIZE.h>`
0337 (see :ref:`below <tut_offline_ptracers_size>`).
0338
0339 - Line 3,
0340
0341 ::
0342
0343 PTRACERS_Iter0= 4248000,
0344
0345 :varlink:`PTRACERS_Iter0` specifies the iteration at which the tracer is to be
0346 introduced.
0347
0348 - Lines 6 and 13,
0349
0350 ::
0351
0352 PTRACERS_advScheme(1)=77,
0353
0354 :varlink:`PTRACERS_advScheme`\ (n) identifies which advection scheme will be used
0355 for tracer n, where n is the number of the tracer up to
0356 :varlink:`PTRACERS_numInUse`. See :numref:`advection_schemes`
0357 to identify the numerical codes used to specify different advection
0358 schemes (e.g. centered 2nd order, 3rd order upwind) as well as details
0359 of each.
0360
0361 - Lines 7 and 14,
0362
0363 ::
0364
0365 PTRACERS_diffKh(1)=1.E3,
0366
0367 :varlink:`PTRACERS_diffKh`\ (n) is the horizontal diffusion coefficient for tracer
0368 n, where n is the number of the tracer up to :varlink:`PTRACERS_numInUse`.
0369
0370 - Lines 8 and 15,
0371
0372 ::
0373
0374 PTRACERS_diffKr(1)=5.E-5,
0375
0376 :varlink:`PTRACERS_diffKr`\ (n) is the vertical diffusion coefficient for tracer n,
0377 where n is the number of the tracer up to :varlink:`PTRACERS_numInUse`.
0378
0379 - Lines 11 and 18,
0380
0381 ::
0382
0383 PTRACERS_initialFile(1)=' ',
0384
0385 :varlink:`PTRACERS_initialFile`\ (n) identifies the initial tracer field to be
0386 associated with tracer n, where n is the number of the tracer up to
0387 PTRACERS\_numInUse. Note that no initial file is specified here.
0388
0389 Note :filelink:`input_tutorial/data.ptracers <verification/tutorial_cfc_offline/input_tutorial/data.ptracers>`
0390 requires a set of entries for each tracer.
0391
0392 File :filelink:`input_tutorial/eedata <verification/tutorial_cfc_offline/input_tutorial/eedata>`
0393 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0394
0395 This file uses standard default values and does not contain
0396 customizations for this experiment.
0397
0398 File :filelink:`code/packages.conf <verification/tutorial_cfc_offline/code/packages.conf>`
0399 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0400
0401 .. literalinclude:: ../../../verification/tutorial_cfc_offline/code/packages.conf
0402 :linenos:
0403 :caption: verification/tutorial_cfc_offline/code/packages.conf
0404
0405 This file is used to invoke the model components required for a
0406 particular implementation of the MITgcm.
0407
0408 .. _tut_offline_ptracers_size:
0409
0410 File :filelink:`code/PTRACERS_SIZE.h <verification/tutorial_cfc_offline/code/PTRACERS_SIZE.h>`
0411 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0412
0413 .. literalinclude:: ../../../verification/tutorial_cfc_offline/code/PTRACERS_SIZE.h
0414 :linenos:
0415 :caption: verification/tutorial_cfc_offline/code/PTRACERS_SIZE.h
0416
0417 - Line 16,
0418
0419 ::
0420
0421 PARAMETER(PTRACERS_num = 2 )
0422
0423 This line sets the parameters :varlink:`PTRACERS_num` (the number of tracers to be
0424 integrated) to 2 (in agreement with :filelink:`input_tutorial/data.ptracers <verification/tutorial_cfc_offline/input_tutorial/data.ptracers>`).
0425
0426 File :filelink:`code/SIZE.h <verification/tutorial_cfc_offline/code/SIZE.h>`
0427 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0428
0429 .. literalinclude:: ../../../verification/tutorial_cfc_offline/code/SIZE.h
0430 :linenos:
0431 :caption: verification/tutorial_cfc_offline/code/SIZE.h
0432
0433 Several lines are customized in this file for the current experiment:
0434
0435 - Line 45,
0436
0437 ::
0438
0439 sNx=64,
0440
0441 this line sets the lateral domain extent in grid points for the axis
0442 aligned with the :math:`x`-coordinate.
0443
0444 - Line 46,
0445
0446 ::
0447
0448 sNy=64,
0449
0450 this line sets the lateral domain extent in grid points for the axis
0451 aligned with the :math:`y`-coordinate.
0452
0453 - Line 55,
0454
0455 ::
0456
0457 Nr=15,
0458
0459 this line sets the vertical domain extent in grid points.
0460
0461 Running the Experiment
0462 ----------------------
0463
0464 In your run directory, as per usual, a copy of all files from the input directory (here, :filelink:`input_tutorial/ <verification/tutorial_cfc_offline/input_tutorial/>`)
0465 are required. In addition, you will also need to copy ``.data`` and ``.meta`` files from directory :filelink:`input/input_off <verification/tutorial_cfc_offline/input/input_off>`.
0466
0467 .. _tut_offline_example2:
0468
0469 A more complicated example
0470 --------------------------
0471
0472 The previous example demonstrated simple advection of a passive tracer using
0473 the offline form of the MITgcm. Now we present a more complicated
0474 example in which the model is used to explore contamination of the
0475 global ocean through surface exposure to CFCs during the last century.
0476 In invoking packages :filelink:`pkg/gchem`, :filelink:`pkg/gmredi` and :filelink:`pkg/cfc` it provides a starting point
0477 and template for more complicated offline modeling, involving as it does
0478 surface forcing through wind and ice fields, more sophisticated mixing,
0479 and a time-varying forcing function.
0480
0481 The run configuration for this experiment resides under the directory
0482 :filelink:`verification/tutorial_cfc_offline/input/` (the code configuration is the same as in the first example,
0483 so the same model executable can be used, i.e., no need to re-compile). The files
0484
0485 - :filelink:`verification/tutorial_cfc_offline/input/data`
0486
0487 - :filelink:`verification/tutorial_cfc_offline/input/data.off`
0488
0489 - :filelink:`verification/tutorial_cfc_offline/input/data.pkg`
0490
0491 - :filelink:`verification/tutorial_cfc_offline/input/data.ptracers`
0492
0493 - :filelink:`verification/tutorial_cfc_offline/input/data.gmredi`
0494
0495 - :filelink:`verification/tutorial_cfc_offline/input/data.gchem`
0496
0497 - :filelink:`verification/tutorial_cfc_offline/input/data.cfc`
0498
0499 - :filelink:`verification/tutorial_cfc_offline/input/eedata`
0500
0501 contain all the parameter settings required.
0502
0503 File :filelink:`input/data <verification/tutorial_cfc_offline/input/data>`
0504 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0505
0506 .. literalinclude:: ../../../verification/tutorial_cfc_offline/input/data
0507 :linenos:
0508 :caption: verification/tutorial_cfc_offline/input/data
0509
0510 A single line must be added (under ``PARM01``, line 21) from the previous example
0511
0512 ::
0513
0514 &PARM01
0515 implicitDiffusion=.TRUE.,
0516 &
0517
0518 When :filelink:`pkg/gmredi` is used, the flag :varlink:`implicitDiffusion` must be assigned
0519 the value ``.TRUE.``
0520
0521 In this example the starting timestep nIter0 is set to 4269600 requiring
0522 model access to pickup files with the suffix 0004269600. The model will
0523 run for 4 timesteps (:varlink:`nTimeSteps` = 4). In this case the frequencies with
0524 which permanent and rolling checkpoints (:varlink:`pChkptFreq` and :varlink:`chkptFreq`) have
0525 been set is sufficiently long to ensure that only one from the last
0526 timestep will be written. This is also true of the values that have been
0527 assigned to the frequency with which dumps are written (:varlink:`dumpFreq`) and
0528 time averaging (:varlink:`taveFreq`) is performed. However, since the model always
0529 dumps the state of the model when it stops without error, a dump will be
0530 written with suffix 0004269604 upon completion.
0531
0532 File :filelink:`input/data.off <verification/tutorial_cfc_offline/input/data.off>`
0533 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0534
0535 .. literalinclude:: ../../../verification/tutorial_cfc_offline/input/data.off
0536 :linenos:
0537 :caption: verification/tutorial_cfc_offline/input/data.off
0538
0539 This file specifies the prefixes
0540 and locations of additional input files required to run the offline
0541 model. Note that directory :filelink:`input/input_off <verification/tutorial_cfc_offline/input/input_off>`
0542 contains only as many offline files
0543 as are required to successfully run for 4 timesteps. Where the GMREDI
0544 scheme was used in the forward run, as here, package GMREDI must again
0545 be invoked when running offline. In this example, tracer is specified as
0546 having been introduced with a non-zero starttime, at timestep 4248000.
0547
0548 File :filelink:`input/data.pkg <verification/tutorial_cfc_offline/input/data.pkg>`
0549 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0550
0551 .. literalinclude:: ../../../verification/tutorial_cfc_offline/input/data.pkg
0552 :linenos:
0553 :caption: verification/tutorial_cfc_offline/input/data.pkg
0554
0555 This file specifies which
0556 MITgcm packages are to be used. It now invokes
0557 additional packages :filelink:`pkg/gmredi` and :filelink:`pkg/gchem`.
0558
0559 File :filelink:`input/data.ptracers <verification/tutorial_cfc_offline/input/data.ptracers>`
0560 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0561
0562 .. literalinclude:: ../../../verification/tutorial_cfc_offline/input/data.ptracers
0563 :linenos:
0564 :caption: verification/tutorial_cfc_offline/input/data.ptracers
0565
0566 This file specifies
0567 parameters associated with the CFC11 and CFC12 tracer fields advected in
0568 this example.
0569
0570 - Line 3,
0571
0572 ::
0573
0574 PTRACERS_Iter0= 4248000,
0575
0576 In this example the tracers were introduced at iteration 4248000.
0577
0578 - Lines 12 and 21,
0579
0580 ::
0581
0582 PTRACERS_diffKh(n)=0.E3,
0583
0584 Since package GMREDI is being used, regular horizontal diffusion is set
0585 to zero.
0586
0587 - Lines 14-15 and 23-24,
0588
0589 ::
0590
0591 PTRACERS_useGMRedi(n)=.TRUE. ,
0592 PTRACERS_useKPP(n)=.FALSE. ,
0593
0594 Setting flag :varlink:`PTRACERS_useGMRedi`\ (n) to ``.TRUE.`` identifies that :filelink:`/pkg/gmredi`
0595 is to be used. Setting flag :varlink:`PTRACERS_useKPP`\ (n) to ``.FALSE.``
0596 explicitly turns off KPP mixing.
0597
0598 - Lines 16 and 25,
0599
0600 ::
0601
0602 PTRACERS_initialFile(n)=' ',
0603
0604 Since this is a ‘pickup’ run the initial tracer files
0605 :varlink:`PTRACERS_initialFile` are not needed.
0606 The model will obtain the tracer state from
0607 ``pickup_ptracers.0004269600.data``
0608
0609 File :filelink:`input/data.gchem <verification/tutorial_cfc_offline/input/data.gchem>`
0610 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0611
0612 .. literalinclude:: ../../../verification/tutorial_cfc_offline/input/data.gchem
0613 :linenos:
0614 :caption: verification/tutorial_cfc_offline/input/data.gchem
0615
0616 This file specifies the parameters
0617 used in :filelink:`/pkg/gchem`.
0618
0619 File :filelink:`input/data.gmredi <verification/tutorial_cfc_offline/input/data.gmredi>`
0620 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0621
0622 .. literalinclude:: ../../../verification/tutorial_cfc_offline/input/data.gmredi
0623 :linenos:
0624 :caption: verification/tutorial_cfc_offline/input/data.gmredi
0625
0626 This file specifies parameters required for :filelink:`/pkg/gmredi`.
0627
0628 File :filelink:`input/cfc1112.atm <verification/tutorial_cfc_offline/input/cfc1112.atm>`
0629 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0630
0631 This is a ASCII data file containing the CFC source
0632 functions over the northern and southern hemispheres annually from 1931
0633 through 1998.
0634
0635 Running the Experiment
0636 ~~~~~~~~~~~~~~~~~~~~~~
0637
08815fc806 Jeff*0638 The model is run as before.
