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

171
/* ***************** FreeflowModels ******************/
172
/*!
173
 * \defgroup FreeflowModels Free Flow Models
174
 * \brief Single-phase Navier Stokes / Stokes model
175
 */
Thomas Fetzer's avatar
Thomas Fetzer committed
176
    /*!
177
     * \ingroup FreeflowModels
178
179
     * \defgroup NavierStokesModel NavierStokes
     * \brief single-phase Navier Stokes flow
180
     * \copydetails ./freeflow/navierstokes/model.hh
181
182
     */
    /*!
183
     * \ingroup FreeflowModels
184
185
     * \defgroup NavierStokesNCModel NavierStokes nc
     * \brief single-phase multi-component Navier Stokes flow
186
     * \copydetails ./freeflow/navierstokesnc/model.hh
187
     */
188
    /*!
189
     * \ingroup FreeflowModels
190
191
     * \defgroup NavierStokesNIModel nonisothermal
     * \brief an energy equation adaptor for isothermal Navier Stokes models
192
     * \copydetails ./freeflow/nonisothermal/model.hh
193
     */
194

195
/* ***************** Benchmarks and Tests ******************/
196
/*!
197
 * \defgroup BenchmarksAndTests Benchmarks and Tests
198
 * \brief Benchmarks and tests used for (automated) testing and demonstration purposes
199
 */
200
201
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup OnePTests 1p (one phase) benchmarks and tests
202
 	 * \brief various tests using a OnePModel. The files are listed below, with hopefully self-explanatory names.
203
204
 	 */
 	/*! \ingroup BenchmarksAndTests
205
206
 	 * \defgroup OnePNCTests 1pnc (one phase, multi-component) benchmarks and tests
 	 * \brief various tests using a OneNCPModel. The files are listed below, with hopefully self-explanatory names.
207
208
 	 */
 	/*! \ingroup BenchmarksAndTests
209
210
 	 * \defgroup OnePNCMinTests 1pncmin (one phase, multi-component mineralization) benchmarks and tests
   * \brief Various tests using the OnePNCMinModel.
211
212
213
 	 */
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup TwoPTests 2p (two phase) benchmarks and tests
214
 	 * \brief various tests using a TwoPModel. The files are listed below, with hopefully self-explanatory names.
215
216
217
 	 */
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup TwoPOneCTests 2p1c (two phase, one component) benchmarks and tests
218
   * \brief various tests using the TwoPOneCModel
219
220
221
 	 */
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup TwoPTwoCTests 2p2c (two phase, two component) benchmarks and tests
222
 	 * \brief various tests using a TwoPTwoCModel. The files are listed below, with hopefully self-explanatory names.
223
224
 	 */
 	/*! \ingroup BenchmarksAndTests
225
226
 	 * \defgroup TwoPNCTests 2pnc (two phase, multi-component) benchmarks and tests
 	 * \brief a fuel cell test problem using the TwoPNCModel. The files are listed below.
227
228
 	 */
 	/*! \ingroup BenchmarksAndTests
229
230
 	 * \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.
231
232
233
 	 */
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup ThreePTests 3p (three phase) benchmarks and tests
234
 	 * \brief various tests using a ThreePModel. The files are listed below, with hopefully self-explanatory names.
235
236
237
 	 */
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup ThreePThreeCTests 3p3c (three phase, three component) benchmarks and tests
238
 	 * \brief various tests using a ThreePThreeCModel. The files are listed below, with hopefully self-explanatory names.
239
240
241
 	 */
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup ThreePWaterOilTests 3pwateroil (three phase, water oil) benchmarks and tests
242
 	 * \brief a SAGD test problem using the ThreePWaterOilModel. The files are listed below.
243
 	 */
244
245
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup CO2Tests CO2 (two phase, two component) benchmarks and tests
246
 	 * \brief a CO2 injection test problem using the TwoPTwoCModel and heterogeneous spatial parameters. The files are listed below.
247
 	 */
248
 	/*! \ingroup BenchmarksAndTests
249
250
 	 * \defgroup MPNCTests MPNC (multi-phase, multi-component) benchmarks and tests
   * \brief various tests using the MPNCModel
251
 	 */
252
253
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup RichardsTests Richards benchmarks and tests
254
 	 * \brief various tests using a RichardsModel. The files are listed below, with hopefully self-explanatory names.
255
 	 */
256
 	/*! \ingroup BenchmarksAndTests
257
258
 	 * \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.
259
 	 */
260
261
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup TracerTests Tracer benchmarks and tests
262
 	 * \brief various tests using a TracerModel. The files are listed below, with hopefully self-explanatory names.
263
 	 */
264

265
/* ***************** Discretization ******************/
266
/*!
267
 * \defgroup Discretization Discretization schemes
268
 * \brief The discretization schemes available in DuMu<sup>x</sup>
269
 */
270
    /*!
271
     * \ingroup Discretization
272
     * \defgroup BoxDiscretization Box FV scheme
273
     *
274
     * \brief The box method is a collocated finite volume scheme with control volumes centered at grid nodes
275
276
     */
    /*!
277
     * \ingroup Discretization
278
279
     * \defgroup CCDiscretization Cell-centered FV scheme
     * \brief Finite volume schemes with degrees of freedom located at grid cell centers
280
281
     */
         /*!
282
         * \ingroup CCDiscretization
283
         * \defgroup CCTpfaDiscretization Two-point flux approximation (Tpfa)
284
         *
285
         * \brief A cell-centered finite volume scheme with two-point flux approximation
286
287
         */
         /*!
288
         * \ingroup CCDiscretization
289
         * \defgroup CCMpfaDiscretization Multi-point flux approximation (Mpfa)
290
         *
291
         * \brief A cell-centered finite volume scheme with multi-point flux approximation
292
293
         */
    /*!
294
     * \ingroup Discretization
295
296
297
     * \defgroup StaggeredDiscretization Staggered FV scheme
     *
     * \brief A staggered finite volume scheme with degrees of freedom at cell-centers and facets
298
299
     */

300
/* ***************** Material ******************/
301
/*!
302
 * \defgroup Material Material and Fluid Framework
303
304
 * \brief The DuMu<sup>x</sup> material and fluid framework with constitutive laws and physics
 * \par
305
306
 * Short description of the most important concepts of the material and fluid framework:
 *
307
308
309
310
311
312
313
314
315
 *  - __Binary coefficient:__ <br>  @copydoc Binarycoefficients
 *  - __Chemistry:__ <br> @copydoc Chemistry
 *  - __Component:__ <br> @copydoc Components
 *  - __Constraint solver:__ <br> @copydoc ConstraintSolver
 *  - __Equation of state:__ <br> @copydoc EOS
 *  - __Fluid-Matrix Interactions:__ <br> @copydoc fluidmatrixinteractions
 *  - __Fluid state:__ <br> @copydoc FluidStates
 *  - __Fluid system:__ <br> @copydoc Fluidsystems
 *  - __Spatial Parameters:__ <br> @copydoc SpatialParameters
Benjamin Faigle's avatar
 
Benjamin Faigle committed
316
 */
317
318
319
    /*!
     * \ingroup Material
     * \defgroup Binarycoefficients Binary Coefficients
320
321
     * \brief binary coefficients
     *
322
323
324
325
326
     *  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.
327
     */
328
329
330
    /*!
     * \ingroup Material
     * \defgroup Chemistry Chemistry
331
332
     * \brief chemical reactions
     *
333
334
335
336
337
     * 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.
     */
338
339
340
    /*!
     * \ingroup Material
     * \defgroup Components Components
341
342
     * \brief components: building blocks for fluid systems
     *
343
344
345
346
347
348
     * 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.
349
     */
350
         /*!
351
352
         * \ingroup Components
         * \defgroup IAPWS IAPWS
353
         * \brief Tabulated values according to the International Association for the Properties of Water and Steam (IAPWS)
354
         */
355
     /*!
356
     * \ingroup Material
357
     * \defgroup ConstraintSolver Constraint Solver
358
359
     * \brief constraint solvers converting primary to secondary variables
     *
360
361
362
363
364
     * 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.
365
366
367
368
369
     * 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.
370
     */
371
372
373
    /*!
     * \ingroup Material
     * \defgroup EOS Equation of State
374
375
     * \brief equations of state
     *
376
377
378
379
380
     * 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.
381
     */
382
383
    /*!
     * \ingroup Material
384
385
386
     * \defgroup fluidmatrixinteractions Fluid-Matrix Interactions
     * \brief e.g. pc-Sw, kr-Sw relations, effective diffusion coefficients
     *
387
388
389
390
391
     * 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.
     */
392
    /*!
Thomas Fetzer's avatar
Thomas Fetzer committed
393
394
     * \ingroup Material
     * \defgroup FluidStates Fluid States
395
     * \brief Fluid states are responsible for representing the
396
     * complete thermodynamic configuration of a system at a given spatial
397
398
399
     * and temporal position.
     *
     * A fluid state always provides access methods
400
401
402
403
404
     * 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.
405
406
407
408
     */
    /*!
     * \ingroup Material
     * \defgroup Fluidsystems Fluid Systems
409
410
411
412
413
414
415
     * \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
416
     */
417
418
419
    /*!
     * \ingroup Material
     * \defgroup SpatialParameters Spatial Parameters
420
421
     * \brief Parameters of the porous matrix and other parameter varying with position (e.g. porosity)
     *
422
423
424
     * 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.
425
     *
426
     */
427

428
429
430
/* ***************** Adaptive ******************/
/*!
 * \defgroup Adaptive Adaptive
431
 * \brief Adaptive grids
432
 */
433

434
435
436
/* ***************** Assembly ******************/
/*!
 * \defgroup Assembly Assembly
437
 * \brief Assembly of linear systems (Jacobian and residual)
438
 */
439

440
/* ***************** Common ******************/
441
/*!
442
 * \defgroup Common Common
443
 * \brief Common classes, functions, properties and concepts
444
 */
445
 	/*!
446
447
  	 * \ingroup Common
  	 * \defgroup Properties Properties
448
  	 * \brief Basic properties of all models in DuMu<sup>x</sup>
449
  	 */
450

451
452
453
/* ***************** InputOutput ******************/
/*!
 * \defgroup InputOutput Input Output
454
 * \brief Classes and functions dealing with input and output of data and grids
455
456
457
458
459
 */

/* ***************** Linear ******************/
/*!
 * \defgroup Linear Linear
460
 * \brief Linear solvers and helpers
461
462
463
464
465
 */

/* ***************** Nonlinear ******************/
/*!
 * \defgroup Nonlinear Nonlinear
466
 * \brief Nonlinear solvers: Newton method
467
468
469
470
471
 */

/* ***************** Parallel ******************/
/*!
 * \defgroup Parallel Parallel
472
 * \brief Helpers for parallel runs with MPI
473
 */