modules.txt 16.5 KB
Newer Older
Benjamin Faigle's avatar
 
Benjamin Faigle committed
1
/*!
2
3
4
 * \file
 *
 * \brief This file contains all module definitions for the doxygen documentation.
Benjamin Faigle's avatar
 
Benjamin Faigle committed
5
 */
6

7
/* ***************** Common ******************/
8
/*!
9
 * \defgroup Common Common Infrastucture
10
 */
11
    /*!
12
13
14
     * \ingroup Common
     * \defgroup BC Boundary Conditions
     */
15
    /*!
16
17
18
     * \ingroup Common
     * \defgroup Math Elementary Math Functions
     */
19
    /*!
20
21
22
     * \ingroup Common
     * \defgroup Exception Exceptions
     */
23
    /*!
24
25
26
     * \ingroup Common
     * \defgroup Linear Linear Solver Backends
     */
27
    /*!
28
29
30
31
32
33
34
35
36
37
38
39
     * \ingroup Common
     * \defgroup Newton Newton Solver
     */
    /*!
     * \ingroup Common
     * \defgroup Parameter Parameters
     * See the file parameterlist for available parameters.
     */
    /*!
     * \ingroup Common
     * \defgroup Properties Property System
     */
40
    /*!
41
42
43
44
45
46
47
     * \ingroup Common
     * \defgroup Spline Splines
     */
    /*!
     * \ingroup Common
     * \defgroup Start Starting the Simulation
     */
48
    /*!
49
50
51
     * \ingroup Common
     * \defgroup SimControl Time Manager
     */
52
    /*!
53
54
55
     * \ingroup Common
     * \defgroup Valgrind Valgrind
     */
56

57
/* ***************** Material ******************/
Benjamin Faigle's avatar
 
Benjamin Faigle committed
58
/*!
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 * \defgroup Material Material and Fluid Framework
 * Short description of the most important concepts of the material and fluid framework:
 *
 *  - _Binary coefficient:_ Binary coefficients describe the relations
 *  of a mixture of two components. Typical binary coefficients are
 *  Henry coefficients or binary molecular diffusion
 *  coefficients. So far, the programming interface for accessing binary
 *  coefficients has not been standardized in Dumux. 
 * 
 *  - _Component:_ Components are fluid systems which provide the
 *  thermodynamic relations for the liquid and gas phase of a single
 *  chemical species or a fixed mixture of species. Their main purpose
 *  is to provide a convenient way to access these quantities from
 *  full-fledged fluid systems. Components are not supposed to be used
 *  by models directly.
 * 
 *  - _Constraint solver:_ Constraint solvers are auxiliary tools to
 *  make sure that a fluid state is consistent with some thermodynamic
 *  constraints. All constraint solvers specify a well defined set of
 *  input variables and make sure that the resulting fluid state is
 *  consistent with a given set of thermodynamic equations.
 * 
 *  - _Equation of state:_ Equations of state (EOS) are auxiliary
 *  classes which provide relations between a fluid phase's temperature,
 *  pressure, composition and density. Since these classes are only used
 *  internally in fluid systems, their programming interface is
 *  currently ad-hoc.
 * 
 *  - _Fluid state:_ Fluid states are responsible for representing the
 *  complete thermodynamic configuration of a system at a given spatial
 *  and temporal position. A fluid state always provides access methods
 *  to __all__ thermodynamic quantities, but the concept of a fluid state does not
 *  mandate what assumptions are made to store these thermodynamic
 *  quantities. What fluid states also do __not__ do is to make sure
 *  that the thermodynamic state which they represent is physically
 *  possible.
 * 
 *  - _Fluid system:_ Fluid systems express the thermodynamic relations 
 *  Strictly speaking, these relations are
 *  functions, mathematically.} between quantities. Since functions do
 *  not exhibit any internal state, fluid systems are stateless classes,
 *  i.e. all member functions are static. This is a conscious
 *  decision since the thermodynamic state of the system is expressed by
 *  a fluid state!
 *   
 *  - _Fluid-Matrix Interactions:_ Some parameters are functions of the fluid state as well as parameters of
 *  the matrix. For example the capillary pressure is a function of the phase saturation
 *  and the shape parameter \f$\lambda\f$ which is dependent on the material. All such relations
 *  are gathered in this module.
 * 
 *  - _Parameter cache:_ Fluid systems sometimes require
 *  computationally expensive parameters for multiple relations. Such
 *  parameters can be cached using a so-called parameter
 *  cache. Parameter cache objects are specific for each fluid system
 *  but they must provide a common interface to update the internal
 *  parameters depending on the quantities which changed since the last
 *  update.
 * 
 *  - _Spatial Parameters:_ All parameters which depend on the matrix and
 *   therefore on the position within the model domain are defined as spatial
 *   parameters. For example permeability, porosity etc.
Benjamin Faigle's avatar
 
Benjamin Faigle committed
120
 */
121
122
123
124
125
126
127
128
129
130
131
132
133
134
    /*!
     * \ingroup Material
     * \defgroup Binarycoefficients Binary Coefficients
     */
    /*!
     * \ingroup Material
     * \defgroup Components Components
     */
        /*!
         * \ingroup Components
         * \defgroup IAPWS IAPWS
         */
    /*!
     * \ingroup Material
135
136
137
138
139
140
141
142
143
144
     * \defgroup ConstraintSolver Constraint Solver
     * Constraint solvers connect the thermodynamic relations expressed by
     * fluid systems with the thermodynamic quantities stored by fluid
     * states. Using them is not mandatory for models, but given the fact
     * that some thermodynamic constraints can be quite complex to solve,
     * sharing this code between models makes sense.
     */   
    /*!
     * \ingroup Material
     * \defgroup EOS Equation of State
145
     */
Thomas Fetzer's avatar
Thomas Fetzer committed
146
147
148
    /*!
     * \ingroup Material
     * \defgroup FluidStates Fluid States
149
150
151
152
153
154
155
     * Fluid state objects express the complete thermodynamic state of a system at a given spatial and
     * temporal position.
     */
    /*!
     * \ingroup Material
     * \defgroup Fluidsystems Fluid Systems
     * Fluid systems express the thermodynamic relations between the quantities of a fluid state.
Thomas Fetzer's avatar
Thomas Fetzer committed
156
     */
157
158
159
160
161
162
163
164
165
166
    /*!
     * \ingroup Material
     *  \defgroup fluidmatrixinteractions Fluid-Matrix Interactions
     */
        /*!
         * \ingroup fluidmatrixinteractions
         *  \defgroup fluidmatrixinteractionslaws Laws for Fluid-Matrix Interactions
         */
         /*!
         * \ingroup fluidmatrixinteractions
167
         *  \defgroup fluidmatrixinteractionsparams Parameters for Fluid-Matrix Interactions
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
         */  
    /*!
     * \ingroup Material
     * \defgroup ParameterCache Parameter Cache
     * All fluid systems must export a type for their __ParameterCache__
     * objects. Parameter caches can be used to cache parameter that are
     * expensive to compute and are required in multiple thermodynamic
     * relations. For fluid systems which do need to cache parameters,
     * Dumux provides a __NullParameterCache__ class.
     * The actual quantities stored by parameter cache objects are specific
     * to the fluid system and no assumptions on what they provide should be
     * made outside of their fluid system. Parameter cache objects provide a
     * well-defined set of methods to make them coherent with a given fluid
     *state, though.
     */ 
183
184
185
186
    /*!
     * \ingroup Material
     * \defgroup SpatialParameters Spatial Parameters
     */
187

188
/* ***************** Fully Implicit ******************/
189
/*!
190
 * \defgroup ImplicitModel Fully Implicit Scheme
191
 */
192
193
194
195
196
197
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitModels Models
     */
        /*!
         * \ingroup ImplicitModels
198
         * \defgroup OnePModel One-phase
199
         *
200
         * \copydetails Dumux::OnePModel
201
202
203
         */
        /*!
         * \ingroup ImplicitModels
204
         * \defgroup OnePTwoCModel One-phase Two-component
205
         *
206
         * \copydetails Dumux::OnePTwoCModel
207
208
209
210
211
212
213
214
215
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup RichardsModel Richards
         *
         * \copydetails Dumux::RichardsModel
         */
        /*!
         * \ingroup ImplicitModels
216
         * \defgroup TwoPModel Two-phase
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
         *
         * \copydetails Dumux::TwoPModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup TwoPNIModel Non-isothermal two-phase
         *
         * \copydetails Dumux::TwoPNIModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup TwoPTwoCModel Two-phase, two-component
         *
         * \copydetails Dumux::TwoPTwoCModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup TwoPTwoCNIModel Non-isothermal two-phase, two-component
         *
         * \copydetails Dumux::TwoPTwoCNIModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup CO2Model CO2
         *
         * \copydetails Dumux::CO2Model
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup CO2NIModel Non-isothermal CO2
         *
         * \copydetails Dumux::CO2NIModel
         */
        /*!
         * \ingroup ImplicitModels
252
         * \defgroup TwoPDFMModel Two-phase flow in discrete fracture-matrix
253
254
255
         *
         * \copydetails Dumux::TwoPDFMModel
         */
256
257
258
259
260
261
        /*!
         * \ingroup ImplicitModels
         * \defgroup ThreePModel Three-phase
         *
         * \copydetails Dumux::ThreePModel
         */
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
        /*!
         * \ingroup ImplicitModels
         * \defgroup ThreePThreeCModel Three-phase, three-component
         *
         * \copydetails Dumux::ThreePThreeCModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup ThreePThreeCNIModel Non-isothermal three-phase, three-component
         *
         * \copydetails Dumux::ThreePThreeCNIModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup MPNCModel M-phase N-component
         *
         * \copydetails Dumux::MPNCModel
         */
        /*!
         * \ingroup ImplicitModels
Thomas Fetzer's avatar
Thomas Fetzer committed
282
         * \defgroup NIModel Non-Isothermal
283
         *
Thomas Fetzer's avatar
Thomas Fetzer committed
284
         * \copydetails Dumux::NIModel
285
286
287
         */
        /*!
         * \ingroup ImplicitModels
Thomas Fetzer's avatar
Thomas Fetzer committed
288
         * \defgroup BoxStokesModel Stokes
289
         *
Thomas Fetzer's avatar
Thomas Fetzer committed
290
         * \copydetails Dumux::StokesModel
291
         */
292
293
294
295
296
297
298
299
300
301
302
303
         /*!
         * \ingroup ImplicitModels
         * \defgroup BoxStokesncModel N-component Stokes
         *
         * \copydetails Dumux::StokesncModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup BoxStokesncniModel Non-isothermal N-component Stokes
         *
         * \copydetails Dumux::StokesncniModel
         */
Hao Wu's avatar
Hao Wu committed
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
        /*!
         * \ingroup ImplicitModels
         * \defgroup BoxZeroEqModel ZeroEq
         *
         * \copydetails Dumux::ZeroEqModel
         */
         /*!
         * \ingroup ImplicitModels
         * \defgroup BoxZeroEqncModel N-component ZeroEq
         *
         * \copydetails Dumux::ZeroEqncModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup BoxZeroEqncniModel Non-isothermal N-component ZeroEq
         *
         * \copydetails Dumux::ZeroEqncniModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup BoxZeroEqModel ZeroEq
         *
         * \copydetails Dumux::ZeroEqModel
         */
         /*!
         * \ingroup ImplicitModels
         * \defgroup BoxZeroEqncModel N-component ZeroEq
         *
         * \copydetails Dumux::ZeroEqncModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup BoxZeroEqncniModel Non-isothermal N-component ZeroEq
         *
         * \copydetails Dumux::ZeroEqncniModel
         */
340
341
        /*!
         * \ingroup ImplicitModels
342
         * \defgroup ElasticBoxModel Linear elastic
343
344
345
346
347
         *
         * \copydetails Dumux::ElasticModel
         */
        /*!
         * \ingroup ImplicitModels
348
         * \defgroup ElOnePTwoCBoxModel One-phase two component linear elastic
349
350
351
352
353
         *
         * \copydetails Dumux::ElOnePTwoCModel
         */
        /*!
         * \ingroup ImplicitModels
354
         * \defgroup ElTwoPBoxModel Two-phase immiscible linear elastic
355
356
357
         *
         * \copydetails Dumux::ElTwoPModel
         */
Thomas Fetzer's avatar
Thomas Fetzer committed
358
359
360
361
362
363
364
365
        /*!
         * \ingroup ImplicitModels
         * \defgroup MultidomainModel Multidomain
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup TwoPTwoCStokesTwoCModel Two-component, Stokes-Darcy
         *
Hao Wu's avatar
Hao Wu committed
366
367
         * \copydetails Dumux::TwoCStokesTwoPTwoCLocalOperator
         * <br><br><br>
Thomas Fetzer's avatar
Thomas Fetzer committed
368
         * \copydetails Dumux::TwoPTwoCModel
Hao Wu's avatar
Hao Wu committed
369
         * <br>
Thomas Fetzer's avatar
Thomas Fetzer committed
370
371
372
373
374
375
         * \copydetails Dumux::StokesncModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup TwoPTwoCNIStokesTwoCNIModel Non-isothermal, two-component, Stokes-Darcy
         *
Hao Wu's avatar
Hao Wu committed
376
377
         * \copydetails Dumux::TwoCNIStokesTwoPTwoCNILocalOperator
         * <br><br><br>
Thomas Fetzer's avatar
Thomas Fetzer committed
378
         * \copydetails Dumux::TwoPTwoCNIModel
Hao Wu's avatar
Hao Wu committed
379
         * <br>
Thomas Fetzer's avatar
Thomas Fetzer committed
380
381
         * \copydetails Dumux::StokesncniModel
         */
Hao Wu's avatar
Hao Wu committed
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
        /*!
         * \ingroup ImplicitModels
         * \defgroup TwoPTwoCZeroEqTwoCModel Two-component, ZeroEq turbulence-Darcy
         *
         * \copydetails Dumux::TwoCStokesTwoPTwoCLocalOperator
         * <br><br><br>
         * \copydetails Dumux::TwoPTwoCModel
         * <br>
         * \copydetails Dumux::ZeroEqncModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup TwoPTwoCNIZeroEqTwoCNIModel Non-isothermal, two-component, ZeroEq turbulence-Darcy
         *
         * \copydetails Dumux::TwoCNIStokesTwoPTwoCNILocalOperator
         * <br><br><br>
         * \copydetails Dumux::TwoPTwoCNIModel
         * <br>
         * \copydetails Dumux::ZeroEqncniModel
         */
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitBaseProblems Base Problems
     */
    /*!
     * \ingroup ImplicitModel
     * \defgroup Discretizations Discretizations
     */
         /*!
         * \ingroup Discretizations
         * \defgroup CCModel Fully implicit cell-centered discretization
         */
         /*!
         * \ingroup Discretizations
         * \defgroup BoxModel Fully implicit box discretization
         */
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitBoundaryTypes Boundary Types
     */
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitFluxVariables Flux Variables
     */
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitIndices Indices
     */
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitLocalJacobian Local Jacobian
     */
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitLocalResidual Local Residual
     */
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitProperties Properties
     */
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitTestProblems Test Problems
     */
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitVolumeVariables Volume Variables
     */
450

451
/* ***************** Sequential ******************/
452
453
454
/*!
 * \defgroup Sequential Sequential Scheme: IMPET (Implicit Pressure Explicit Transport)
 */
455

456
457
458
    /*!
     * \ingroup Sequential
     * \defgroup IMPET Models
459
460
461
462
463
464
465
     */

       /*!
        * \ingroup IMPET
        * \defgroup mpfa MPFA framework
        */

466
467
468
        /*!
         * \ingroup IMPET
         * \defgroup OnePhase Single Phase (FV)
469
         */
470
471
472
473
474
475
476
            /*!
             * \ingroup OnePhase
             * \defgroup Pressure1p Pressure Equation
             */
                /*!
                 * \ingroup Pressure1p
                 * \defgroup FV1p Finite Volume
477
                 */
478
479
480
        /*!
         * \ingroup IMPET
         * \defgroup IMPES Immiscible IMPES
481
         */
482
483
484
485
486
487
488
            /*!
             * \ingroup IMPES
             * \defgroup Pressure2p Immiscible Pressure Equation
             */
                /*!
                 * \ingroup Pressure2p
                 * \defgroup FVPressure2p Finite Volume
489
                 */
490
491
492
                /*!
                * \ingroup Pressure2p
                * \defgroup MimeticPressure2p Mimetic Finite Differences
493
                */
494
495
496
497
498
499
500
            /*!
             * \ingroup IMPES
             * \defgroup Saturation2p Immiscible Saturation Transport
             */
                /*!
                 * \ingroup Saturation2p
                 * \defgroup FVSaturation2p Finite Volume
501
                 */
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
        /*!
         * \ingroup IMPET
         * \defgroup IMPEC Miscible (Compositional) IMPEC
         */
            /*!
             * \ingroup IMPEC
             * \defgroup multiphase Multiphase Compositional Models
             */
                /*!
                * \ingroup multiphase
                * \defgroup Adaptive2p2c (Grid-)Adaptive Multiphase Compositional Models
                */
            /*!
             * \ingroup IMPEC
             * \defgroup multiphysics Multiphysics Compositional Models
             */
    /*!
     * \ingroup Sequential
     * \defgroup IMPETproblems Base Problems
     */
    /*!
     * \ingroup Sequential
     * \defgroup IMPETProperties Properties
     */
    /*!
     * \ingroup Sequential
     * \defgroup IMPETtests Test Problems
     */
530