modules.txt 28.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.
5
 *
Benjamin Faigle's avatar
 
Benjamin Faigle committed
6
 */
7

8
/* ***************** Porousmediumflow ******************/
9
/*!
10
 * \defgroup PorousmediumflowModels Porous-Medium Flow Models
11
 * \brief Single and multi-phase models for flow and transport in porous materials
12
 */
13
    /*!
14
     * \ingroup PorousmediumflowModels
15
     * \defgroup OnePModel 1p
16
     * \brief Single-phase (immiscible) Darcy flow
17
18
     * \copydetails ./porousmediumflow/1p/model.hh
     */
19
20
21
22
23
24
25
26
27
28
29
        /*!
         * \ingroup OnePModel
         * \defgroup SequentialOnePModel Sequential
         * \brief Sequential single-phase (immiscible) Darcy flow
         *
         * # Pressure
         * \copydetails Dumux::FVPressure1P
         *
         * # Velocity
         * \copydetails Dumux::FVVelocity1P
         */
30
31
    /*!
     * \ingroup PorousmediumflowModels
32
     * \defgroup OnePNCModel 1pnc
33
     * \brief Single-phase, multi-component Darcy flow
34
     * \copydetails ./porousmediumflow/1pnc/model.hh
35
     */
36
    /*!
37
     * \ingroup PorousmediumflowModels
38
     * \defgroup OnePNCMinModel 1pncmin
39
     * \brief Single-phase, multi-component Darcy flow with mineralization
40
     * \copydetails ./porousmediumflow/1pncmin/model.hh
41
     */
42
    /*!
43
     * \ingroup PorousmediumflowModels
44
     * \defgroup TwoPModel 2p
45
     * \brief Two-phase (immiscible) Darcy flow
46
     * \copydetails ./porousmediumflow/2p/model.hh
47
     */
48
        /*!
49
50
         * \ingroup TwoPModel
         * \defgroup SequentialTwoPModel Sequential
51
52
         * \brief Sequential two-phase (immiscible) Darcy flow
         *
53
         * # Pressure
54
         * \copydetails Dumux::FVPressure2P
55
         *
56
         * # Velocity
57
         * \copydetails Dumux::FVVelocity2P
58
         */
59
    /*!
60
     * \ingroup PorousmediumflowModels
61
     * \defgroup TwoPOneCModel 2p1c
62
     * \brief Two-phase, one-component Darcy flow
63
     * \copydetails ./porousmediumflow/2p1c/model.hh
64
     */
65
    /*!
66
     * \ingroup PorousmediumflowModels
67
     * \defgroup TwoPTwoCModel 2p2c
68
     * \brief Two-phase, two-component Darcy flow
69
     * \copydetails ./porousmediumflow/2p2c/model.hh
70
     */
71
        /*!
72
73
         * \ingroup TwoPTwoCModel
         * \defgroup SequentialTwoPTwoCModel Sequential
74
75
         * \brief Sequential two-phase, two-component Darcy flow
         *
76
         * # Pressure
77
         * \copydetails Dumux::FVPressure2P2C
78
         *
79
         * # Velocity
80
         * \copydetails Dumux::FVTransport2P2C
81
         */
82
    /*!
83
     * \ingroup PorousmediumflowModels
84
85
     * \defgroup TwoPNCModel 2pnc
     * \brief two-phase, multi-component Darcy flow
86
     * \copydetails ./porousmediumflow/2pnc/model.hh
87
88
     */
    /*!
89
     * \ingroup PorousmediumflowModels
90
     * \defgroup TwoPNCMinModel 2pncmin
91
     * \brief Two-phase, multi-component Darcy flow with mineralization
92
     * \copydetails ./porousmediumflow/2pncmin/model.hh
93
     */
94
    /*!
95
     * \ingroup PorousmediumflowModels
96
     * \defgroup ThreePModel 3p
97
     * \brief Three-phase (immiscible) Darcy flow
98
     * \copydetails ./porousmediumflow/3p/model.hh
99
100
     */
    /*!
101
     * \ingroup PorousmediumflowModels
102
     * \defgroup ThreePThreeCModel 3p3c
103
     * \brief Three-phase, three-component Darcy flow
104
     * \copydetails ./porousmediumflow/3p3c/model.hh
105
     */
106
    /*!
107
     * \ingroup PorousmediumflowModels
108
     * \defgroup ThreePWaterOilModel 3pwateroil
109
     * \brief Three-phase, two-component Darcy flow with water (liquid & gas) and oil
110
     * \copydetails ./porousmediumflow/3pwateroil/model.hh
111
     */
112
113
114
115
116
117
    /*!
     * \ingroup PorousmediumflowModels
     * \defgroup BoxDFMModel boxdfm
     * \brief \todo
     * \copydetails ./porousmediumflow/boxdfm/model.hh
     */
118
    /*!
119
     * \ingroup PorousmediumflowModels
120
     * \defgroup CO2Model CO2
121
     * \brief Two-phase, two-component Darcy flow specialized for supercritical CO<sub>2</sub> storage
122
     * \copydetails ./porousmediumflow/co2/model.hh
123
     */
124
    /*!
125
     * \ingroup PorousmediumflowModels
126
     * \defgroup MineralizationModel mineralization
127
     * \brief Model adding components that can precipitate as a solid phase to a standard Darcy flow model
128
     *
129
     * \copydetails ./porousmediumflow/mineralization/model.hh
130
     */
131
    /*!
132
     * \ingroup PorousmediumflowModels
133
     * \defgroup MPNCModel mpnc
134
     * \brief Generalized multi-phase, multi-component Darcy flow
135
     *
136
     * \copydetails ./porousmediumflow/mpnc/model.hh
137
     */
138
139
    /*!
     * \ingroup PorousmediumflowModels
140
     * \defgroup NonEquilibriumModel NonEquilibrium
141
     * \brief Model that adds nonequilibrium equations to another porous medium flow model (only used in MPNCModel currently)
142
143
     * \copydetails ./porousmediumflow/nonequilibrium/model.hh
     */
144
        /*!
145
146
         * \ingroup NonEquilibriumModel
         * \defgroup ThermalNonEquilibriumModel ThermalNonEquilibrium
147
         * \brief Model that adapts the energy localresidual to thermal nonequilibrium
148
149
         * \copydetails ./porousmediumflow/nonequilibrium/thermal/localresidual.hh
         */
150
    /*!
151
     * \ingroup PorousmediumflowModels
152
     * \defgroup NIModel nonisothermal
153
     * \brief Model that adds an energy equation (thermal equilibrium) to another porous medium flow model
154
     *
155
     * \copydetails ./porousmediumflow/nonisothermal/model.hh
156
     */
157
    /*!
158
     * \ingroup PorousmediumflowModels
159
160
     * \defgroup RichardsModel Richards
     * \brief Richards flow
161
     * \copydetails ./porousmediumflow/richards/model.hh
162
163
     */
    /*!
164
     * \ingroup PorousmediumflowModels
165
166
     * \defgroup RichardsNCModel Richards nc
     * \brief Richards multi-component flow
167
     * \copydetails ./porousmediumflow/richardsnc/model.hh
168
     */
169
170
171
172
173
174
    /*!
     * \ingroup PorousmediumflowModels
     * \defgroup SolidEnergyModel Solid energy
     * \brief Energy equation for the solid (general heat equation)
     * \copydetails ./porousmediumflow/solidenergy/model.hh
     */
175
    /*!
176
     * \ingroup PorousmediumflowModels
177
178
     * \defgroup TracerModel Tracer
     * \brief Multi-component advection-diffusion-reaction model with given velocity field
179
     * \copydetails ./porousmediumflow/tracer/model.hh
180
     */
181

182
/* ***************** FreeflowModels ******************/
183
/*!
184
 * \defgroup FreeflowModels Free Flow Models
185
 * \brief Single-phase models basing on the Navier-Stokes equation
186
 */
187
    /*!
188
     * \ingroup FreeflowModels
189
190
     * \defgroup NavierStokesModel Navier-Stokes
     * \brief Single-phase Navier-Stokes flow
191
     * \copydetails ./freeflow/navierstokes/model.hh
192
     */
193
194
195
196
197
198
    /*!
     * \ingroup FreeflowModels
     * \defgroup RANSModel Reynolds-Averaged Navier-Stokes
     * \brief Single-phase Reynolds-Averaged Navier-Stokes flow
     * \copydetails ./freeflow/rans/model.hh
     */
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
        /*!
         * \ingroup RANSModel
         * \defgroup ZeroEqModel 0-Eq. Models
         * \brief Zero-equation or algebraic turbulence models
         * \copydetails ./freeflow/rans/zeroeq/model.hh
         */
        /*!
         * \ingroup RANSModel
         * \defgroup OneEqModel 1-Eq. Models
         * \brief One-equation turbulence model by Spalart-Allmaras
         * \copydetails ./freeflow/rans/oneeq/model.hh
         */
        /*!
         * \ingroup RANSModel
         * \defgroup TwoEqModel 2-Eq. Models
         * \brief Two-equation turbulence models
         */
216
217
218
219
220
221
        /*!
         * \ingroup TwoEqModel
         * \defgroup KEpsilonModel K-epsilon model
         * \brief K-epsilon model
         * \copydetails ./freeflow/rans/twoeq/kepsilon/model.hh
         */
222
223
224
225
226
227
        /*!
         * \ingroup TwoEqModel
         * \defgroup KOmegaModel K-omega model
         * \brief K-omega model
         * \copydetails ./freeflow/rans/twoeq/komega/model.hh
         */
228
229
230
231
232
233
        /*!
         * \ingroup TwoEqModel
         * \defgroup LowReKEpsilonModel Low-Re k-epsilon model
         * \brief Low-Re k-epsilon model
         * \copydetails ./freeflow/rans/twoeq/lowrekepsilon/model.hh
         */
234
235
    /*!
     * \ingroup FreeflowModels
236
237
     * \defgroup FreeflowNCModel Compositional
     * \brief Single-phase multi-component free-flow flow models
238
     * \copydetails ./freeflow/compositional/navierstokesncmodel.hh
239
     */
240
241
242
243
244
245
    /*!
     * \ingroup FreeflowModels
     * \defgroup FreeflowNIModel Nonisothermal
     * \brief An energy equation adaptor for isothermal free-flow models
     * \copydetails ./freeflow/nonisothermal/model.hh
     */
246
247
248
249
250
251
    /*!
     * \ingroup FreeflowModels
     * \defgroup ShallowWaterModel 2D shallow water model
     * \brief Two-dimensional shallow water flow (depth-averaged)
     * \copydetails ./freeflow/shallowwater/model.hh
     */
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
/*!
 * \defgroup Geomechanics Geomechanics Models
 * \brief Models for taking into account solid deformation
 */
    /*!
     * \ingroup Geomechanics
     * \defgroup Elastic Solid mechanics w/o fluid pressure
     * \brief Models linear elastic deformation of a solid. Disregards fluid pressure.
     * \copydetails ./geomechanics/elastic/model.hh
     */
    /*!
     * \ingroup Geomechanics
     * \defgroup PoroElastic Solid mechanics with fluid pressure
     * \brief Models linear elastic deformation of a solid. Takes fluid pressure into account.
     * \copydetails ./geomechanics/poroelastic/model.hh
     */
268

269
/* ***************** Benchmarks and Tests ******************/
270
/*!
271
 * \defgroup BenchmarksAndTests Benchmarks and Tests
272
 * \brief Benchmarks and tests used for (automated) testing and demonstration purposes
273
 */
274
    /*!
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
     * \ingroup BenchmarksAndTests
     * \defgroup PorousmediumflowTests Porous-Medium Flow Tests
     * \brief Single and multi-phase tests for flow and transport in porous materials
     */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup OnePTests 1p (one phase) benchmarks and tests
         * \brief Various tests using a OnePModel. The files are listed below.
         */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup OnePNCTests 1pnc (one phase, multi-component) benchmarks and tests
         * \brief Various tests using a OnePNCModel. The files are listed below.
         */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup OnePNCMinTests 1pncmin (one phase, multi-component mineralization) benchmarks and tests
         * \brief Various tests using the OnePNCMinModel. The files are listed below.
         */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup TwoPTests 2p (two phase) benchmarks and tests
         * \brief Various tests using a TwoPModel. The files are listed below.
         */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup TwoPOneCTests 2p1c (two phase, one component) benchmarks and tests
         * \brief Various tests using the TwoPOneCModel. The files are listed below.
         */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup TwoPTwoCTests 2p2c (two phase, two component) benchmarks and tests
         * \brief Various tests using a TwoPTwoCModel. The files are listed below.
         */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup TwoPNCTests 2pnc (two phase, multi-component) benchmarks and tests
         * \brief A fuel cell test problem using the TwoPNCModel. The files are listed below.
         */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup TwoPNCMinTests 2pncmin (two phase, multi-component mineralization) benchmarks and tests
         * \brief A salt dissolution test problem using the TwoPNCMinModel. The files are listed below.
         */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup ThreePTests 3p (three phase) benchmarks and tests
         * \brief Various tests using a ThreePModel. The files are listed below.
         */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup ThreePThreeCTests 3p3c (three phase, three component) benchmarks and tests
         * \brief Various tests using a ThreePThreeCModel. The files are listed below.
         */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup ThreePWaterOilTests 3pwateroil (three phase, water oil) benchmarks and tests
         * \brief A SAGD test problem using the ThreePWaterOilModel. The files are listed below.
         */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup CO2Tests CO2 (two phase, two component) benchmarks and tests
         * \brief A CO2 injection test problem using the TwoPTwoCModel and heterogeneous spatial parameters. The files are listed below.
         */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup MPNCTests MPNC (multi-phase, multi-component) benchmarks and tests
         * \brief Various tests using the MPNCModel. The files are listed below.
         */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup RichardsTests Richards benchmarks and tests
         * \brief Various tests using a RichardsModel. The files are listed below.
         */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup RichardsNCTests Richards multi-component benchmarks and tests
         * \brief A multi-component transport problem in the unsaturated zone using the RichardsNCModel. The files are listed below.
         */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup TracerTests Tracer benchmarks and tests
         * \brief Various tests using a TracerModel. The files are listed below.
         */
    /*!
     * \ingroup BenchmarksAndTests
     * \defgroup FreeflowTests Free Flow Tests
     * \brief Various tests for single-phase Navier-Stokes / Stokes tests
     */
        /*!
         * \ingroup FreeflowTests
         * \defgroup NavierStokesTests Single-phase Navier-Stokes tests
         * \brief Various tests using a single-phase Navier-Stokes flow. The files are listed below.
         */
        /*!
         * \ingroup FreeflowTests
         * \defgroup NavierStokesNCTests Single-phase Navier-Stokes nc tests
         * \brief Various tests using a single-phase Navier-Stokes flow with n components. The files are listed below.
         */
        /*!
         * \ingroup FreeflowTests
         * \defgroup RANSTests Reynolds-Averaged Navier-Stokes tests
         * \brief  Various tests using a single-phase Reynolds-Averaged Navier-Stokes flow. The files are listed below.
         */
        /*!
         * \ingroup FreeflowTests
         * \defgroup RANSNCTests Reynolds-Averaged Navier-Stokes nc tests
         * \brief  Various tests using a single-phase Reynolds-Averaged Navier-Stokes flow with n components. The files are listed below.
         */
384
385
386
387
388
        /*!
         * \ingroup FreeflowTests
         * \defgroup ShallowWaterTests 2D shallow water tests
         * \brief Tests for the two-dimensional shallow water model. The files are listed below.
         */
389
390
391
392
393
    /*!
     * \ingroup BenchmarksAndTests
     * \defgroup GeomechanicsTests Geomechanics Tests
     * \brief Various tests using the geomechanics elastic or poroelastic models. The files are listed below.
     */
394
395
396
397
398
    /*!
      * \ingroup BenchmarksAndTests
      * \defgroup MaterialTests Material system tests
      * \brief Benchmarks and Test(s) for the material system.
      */
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
    /*!
     * \ingroup BenchmarksAndTests
     * \defgroup MultiDomainTests MultiDomain tests
     * \brief Various tests for multidomain problems.
     */
        /*!
         * \ingroup MultiDomainTests
         * \defgroup BoundaryTests MultiDomain boundary tests
         * \brief Various tests using a boundary as coupling interface: Darcy-Stokes coupling or PNM (pore network model)-Darcy. The files are listed below.
         */
        /*!
         * \ingroup MultiDomainTests
         * \defgroup EmbeddedTests Embedded MultiDomain tests
         * \brief Various tests for embedded coupling problems with different dimensions: Root-soil interaction or embedded fracture models. The files are listed below.
         */
        /*!
         * \ingroup MultiDomainTests
         * \defgroup FacetTests Facet MultiDomain tests
         * \brief Various tests for facet coupling problems with different dimensions: Discrete facet conforming fracture models and problems with physics on a domain surface. The files are listed below.
         */
        /*!
         * \ingroup MultiDomainTests
         * \defgroup PoromechanicsTests Facet MultiDomain tests
         * \brief Various tests coupling poromechanics and fluid flow. The files are listed below.
         */
424

425
/* ***************** Discretization ******************/
426
/*!
427
 * \defgroup Discretization Discretization schemes
428
 * \brief The discretization schemes available in DuMu<sup>x</sup>
429
 */
430
    /*!
431
     * \ingroup Discretization
432
     * \defgroup BoxDiscretization Box FV scheme
433
     * \brief The box method is a collocated finite volume scheme with control volumes centered at grid nodes.
434
435
     */
    /*!
436
     * \ingroup Discretization
437
     * \defgroup CCDiscretization Cell-centered FV scheme
438
     * \brief Finite volume schemes with degrees of freedom located at grid cell centers.
439
     */
440
        /*!
441
         * \ingroup CCDiscretization
442
         * \defgroup CCTpfaDiscretization Two-point flux approximation (Tpfa)
443
         * \brief A cell-centered finite volume scheme with two-point flux approximation.
444
         */
445
        /*!
446
         * \ingroup CCDiscretization
447
         * \defgroup CCMpfaDiscretization Multi-point flux approximation (Mpfa)
448
         * \brief A cell-centered finite volume scheme with multi-point flux approximation.
449
450
         */
    /*!
451
     * \ingroup Discretization
452
     * \defgroup StaggeredDiscretization Staggered FV scheme
453
     * \brief A staggered finite volume scheme with degrees of freedom at cell-centers and facets.
454
     */
455
/* ***************** Flux ******************/
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
/*!
 * \defgroup Flux Flux
 * \brief All flux related things available in DuMu<sup>x</sup>
 */
    /*!
     * \ingroup Flux
     * \defgroup BoxFlux Flux related to the Box scheme
     * \brief Flux related to the box scheme
     */
    /*!
     * \ingroup Flux
     * \defgroup CCFlux Flux related to the cell-centered schemes
     * \brief Flux related to the cell-centered schemes
     */
        /*!
         * \ingroup Flux
         * \defgroup CCTpfaFlux Flux related to the cell-centered two-point flux approximation schemes
         * \brief Flux related to the cell-centered two-point flux approximation schemes
         */
        /*!
         * \ingroup Flux
         * \defgroup CCMpfaFlux Flux related to the cell-centered multi-point flux approximation schemes
         * \brief Flux related to the cell-centered multi-point flux approximation schemes
         */
    /*!
     * \ingroup Flux
     * \defgroup StaggeredFlux Flux related to the staggered scheme
     * \brief Flux related to the staggered scheme
     */
485
486
487
488
489
    /*!
     * \ingroup Flux
     * \defgroup ShallowWaterFlux Flux related to the shallow water model
     * \brief Flux related to the shallow water model
     */
490
/* ***************** Material ******************/
491
/*!
492
 * \defgroup Material Material and Fluid Framework
493
494
 * \brief The DuMu<sup>x</sup> material and fluid framework with constitutive laws and physics
 * \par
495
496
 * Short description of the most important concepts of the material and fluid framework:
 *
497
498
499
 *  - __Binary coefficient:__ <br>  @copydoc Binarycoefficients
 *  - __Chemistry:__ <br> @copydoc Chemistry
 *  - __Component:__ <br> @copydoc Components
500
 *  - __Constraint solvers:__ <br> @copydoc ConstraintSolvers
501
 *  - __Equation of state:__ <br> @copydoc EOS
502
 *  - __Fluid-Matrix Interactions:__ <br> @copydoc Fluidmatrixinteractions
503
 *  - __Fluid state:__ <br> @copydoc FluidStates
504
 *  - __Solid state:__ <br> @copydoc SolidStates
505
506
 *  - __Fluid system:__ <br> @copydoc Fluidsystems
 *  - __Spatial Parameters:__ <br> @copydoc SpatialParameters
Benjamin Faigle's avatar
 
Benjamin Faigle committed
507
 */
508
    /*!
509
510
     * \ingroup Material
     * \defgroup Binarycoefficients Binary Coefficients
511
     * \brief Binary coefficients
512
     *
513
514
515
516
517
     *  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.
518
     */
519
520
521
    /*!
     * \ingroup Material
     * \defgroup Chemistry Chemistry
522
     * \brief Chemical reactions
523
     *
524
525
526
527
528
     * Chemical reactions can be relevant for all thermodynamic relations
     * for the liquid and gas phase of multiple chemical species
     * The main purpose is to provide a convenient way to access these
     * relationships via source or sink terms.
     */
529
530
531
    /*!
     * \ingroup Material
     * \defgroup Components Components
Bernd Flemisch's avatar
Bernd Flemisch committed
532
     * \brief thermodynamics of single chemical species or fixed mixtures of species
533
     *
Bernd Flemisch's avatar
Bernd Flemisch committed
534
535
536
537
     * Components provide the thermodynamic relations for the liquid,
     * gaseous and/or solid state of a single
     * chemical species or a _fixed_ mixture of species.
     * Fluid systems use components to compute thermodynamic quantities of phases.
538
     */
539
        /*!
540
541
         * \ingroup Components
         * \defgroup IAPWS IAPWS
542
         * \brief Tabulated values according to the International Association for the Properties of Water and Steam (IAPWS)
543
         */
544
    /*!
545
     * \ingroup Material
546
     * \defgroup ConstraintSolvers Constraint Solvers
547
     * \brief Constraint solvers converting primary to secondary variables
548
     *
549
550
551
552
553
     * 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.
554
555
556
557
558
     * 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.
559
     */
560
561
562
    /*!
     * \ingroup Material
     * \defgroup EOS Equation of State
563
     * \brief Equations of state
564
     *
565
566
567
568
569
     * 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.
570
     */
571
572
    /*!
     * \ingroup Material
573
     * \defgroup Fluidmatrixinteractions Fluid-Matrix Interactions
574
575
     * \brief e.g. pc-Sw, kr-Sw relations, effective diffusion coefficients
     *
576
577
578
579
580
     * 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.
     */
581
    /*!
Thomas Fetzer's avatar
Thomas Fetzer committed
582
583
     * \ingroup Material
     * \defgroup FluidStates Fluid States
584
     * \brief Fluid states are responsible for representing the
585
     * complete thermodynamic configuration of a system at a given spatial
586
587
588
     * and temporal position.
     *
     * A fluid state always provides access methods
589
590
591
592
593
     * 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.
594
595
596
597
     */
    /*!
     * \ingroup Material
     * \defgroup Fluidsystems Fluid Systems
598
599
600
601
602
603
604
     * \brief Fluid systems express the thermodynamic relations (functions).
     *
     * 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!
Thomas Fetzer's avatar
Thomas Fetzer committed
605
     */
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
    /*!
     * \ingroup Material
     * \defgroup SolidStates Solid States
     * \brief Solid states are responsible for representing all relevant
     * thermodynamic quantities of solid systems.
     *
     * A solid state provides access methods
     * to __all__ thermodynamic quantities, but the concept of a solid state does not
     * mandate what assumptions are made to store these thermodynamic
     * quantities. What solid states also do __not__ do is to make sure
     * that the thermodynamic state which they represent is physically
     * possible.
     */
    /*!
     * \ingroup Material
     * \defgroup SolidSystems Solid Systems
     * \brief Solid systems express the thermodynamic relations (functions).
     *
     * Since functions do
     *  not exhibit any internal state, solid 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 solid state!
     */
630
631
632
    /*!
     * \ingroup Material
     * \defgroup SpatialParameters Spatial Parameters
633
634
     * \brief Parameters of the porous matrix and other parameter varying with position (e.g. porosity)
     *
635
636
637
     * 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.
638
     *
639
     */
640

641
642
643
/* ***************** Adaptive ******************/
/*!
 * \defgroup Adaptive Adaptive
644
 * \brief Adaptive grids
645
 */
646

647
648
649
650
651
652
/* ***************** Assembly and Solvers ******************/
/*!
 * \defgroup AssemblyAndSolvers Assembly and Solvers
 * \brief Assembling matrices and vectors, solvers for linear and nonlinear equations
 */

653
654
/* ***************** Assembly ******************/
/*!
655
 * \ingroup AssemblyAndSolvers
656
 * \defgroup Assembly Assembly
657
 * \brief Assembly of linear systems (Jacobian and residual)
658
 */
659

660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
/* ***************** Linear ******************/
/*!
 * \ingroup AssemblyAndSolvers
 * \defgroup Linear Linear
 * \brief Linear solvers and helpers
 */

/* ***************** Nonlinear ******************/
/*!
 * \ingroup AssemblyAndSolvers
 * \defgroup Nonlinear Nonlinear
 * \brief Nonlinear solvers: Newton method
 */

 /* ***************** Common ******************/
675
/*!
676
 * \defgroup Common Common
677
 * \brief Common classes, functions, properties and concepts
678
 */
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
    /*!
     * \ingroup Common
     * \defgroup Geometry Geometry
     * \brief Basic geometries in DuMu<sup>x</sup>
     */
    /*!
     * \ingroup Common
     * \defgroup Properties Properties
     * \brief Basic properties of all models in DuMu<sup>x</sup>
     */
    /*!
     * \ingroup Common
     * \defgroup Typetraits Typetraits
     * \brief Basic Type traits in DuMu<sup>x</sup>
     */
694

695
696
697
/* ***************** InputOutput ******************/
/*!
 * \defgroup InputOutput Input Output
698
 * \brief Classes and functions dealing with input and output of data and grids
699
700
 */

701
702
703
704
705
706
707
708
/* ***************** MultiDomain ******************/
/*!
 * \defgroup MultiDomain Multidomain simulations
 * \brief Classes to run problems with multiple domains
 *
 * The multi domain module allows to couple regular DuMu<sup>x</sup> problems.
 * Several coupling modes are currently available.
 */
709
710
711
712
713
    /*!
     * \ingroup MultiDomain
     * \defgroup BoundaryCoupling Boundary coupling mode
     * \brief Couples problems of different or equal dimension that touch at the domain boundary. Examples are equal-dimension multi-physics problems like Darcy-Stokes coupling or PNM (pore network model)-Darcy coupling.
     */
714
715
716
717
718
719
720
721
722
723
        /*!
         * \ingroup BoundaryCoupling
         * \defgroup DarcyDarcyCoupling Darcy-Darcy domain coupling
         * \brief Couples domains with equal-dimension multi-physics problems in a Darcy-Darcy coupling.
         */
        /*!
         * \ingroup BoundaryCoupling
         * \defgroup StokesDarcyCoupling Stokes-Darcy domain coupling
         * \brief Couples domains with equal-dimension multi-physics problems in a Stokes-Darcy coupling.
         */
724
725
726
727
728
729
730
731
732
733
    /*!
     * \ingroup MultiDomain
     * \defgroup EmbeddedCoupling Embedded mixed-dimension coupling mode
     * \brief Couples problems of different dimensions where one or more lower-dimensional problems (lowdim) are embedded in a          higher-dimensional domain (bulk). Examples are embedded one-dimensional networks for the simulation of blood tissue perfusion, or root-soil interaction, and embedded fracture models.
     */
    /*!
     * \ingroup MultiDomain
     * \defgroup FacetCoupling Conforming mixed-dimension facet coupling mode
     * \brief Couples problems of different dimensions where one or more lower-dimensional problems (lowdim) live on the facets of the          higher-dimensional domain (bulk). Examples are discrete facet conforming fracture models and problems with physics on a domain surface.
     */