modules.txt 19.1 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
19
20
21
     * \copydetails ./porousmediumflow/1p/model.hh
     */
       /*!
        * \ingroup OnePModel
        * \defgroup SequentialOnePModel Sequential
22
23
        * \brief Sequential single-phase (immiscible) Darcy flow
        *
24
25
        * # Pressure
        * \copydetails ./porousmediumflow/1p/sequential/diffusion/cellcentered/pressure.hh
26
        *
27
28
29
30
31
        * # Velocity
        * \copydetails ./porousmediumflow/1p/sequential/diffusion/cellcentered/velocity.hh
        */
    /*!
     * \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
54
         * # Pressure
         * \copydetails ./porousmediumflow/2p/sequential/diffusion/cellcentered/pressure.hh
55
         *
56
57
         * # Velocity
         * \copydetails ./porousmediumflow/2p/sequential/diffusion/cellcentered/velocity.hh
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
77
         * # Pressure
         * \copydetails ./porousmediumflow/2p2c/sequential/fvpressure.hh
78
         *
79
80
         * # Velocity
         * \copydetails ./porousmediumflow/2p2c/sequential/fvtransport.hh
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
     * \ingroup PorousmediumflowModels
114
     * \defgroup CO2Model CO2
115
     * \brief Two-phase, two-component Darcy flow specialized for supercritical CO<sub>2</sub> storage
116
     * \copydetails ./porousmediumflow/co2/model.hh
117
     */
118
    /*!
119
     * \ingroup PorousmediumflowModels
120
     * \defgroup MineralizationModel mineralization
121
     * \brief Model adding components that can precipitate as a solid phase to a standard Darcy flow model
122
     *
123
     * \copydetails ./porousmediumflow/mineralization/model.hh
124
     */
125
    /*!
126
     * \ingroup PorousmediumflowModels
127
     * \defgroup MPNCModel mpnc
128
     * \brief Generalized multi-phase, multi-component Darcy flow
129
     *
130
     * \copydetails ./porousmediumflow/mpnc/model.hh
131
     */
132
133
134
    /*!
     * \ingroup PorousmediumflowModels
     * \defgroup PorousmediumNonEquilibriumModel NonEquilibrium 
135
     * \brief Model that adds nonequilibrium equations to another porous medium flow model (only used in MPNCModel currently)
136
137
     * \copydetails ./porousmediumflow/nonequilibrium/model.hh
     */
138
		/*!
139
140
         * \ingroup PorousmediumNonEquilibriumModel
         * \defgroup PorousmediumThermalNonEquilibriumModel ThermalNonEquilibrium
141
         * \brief Model that adapts the energy localresidual to thermal nonequilibrium
142
143
         * \copydetails ./porousmediumflow/nonequilibrium/thermal/localresidual.hh
         */
144
    /*!
145
     * \ingroup PorousmediumflowModels
146
     * \defgroup NIModel nonisothermal
147
     * \brief Model that adds an energy equation (thermal equilibrium) to another porous medium flow model
148
     *
149
     * \copydetails ./porousmediumflow/nonisothermal/model.hh
150
     */
151
    /*!
152
     * \ingroup PorousmediumflowModels
153
154
     * \defgroup RichardsModel Richards
     * \brief Richards flow
155
     * \copydetails ./porousmediumflow/richards/model.hh
156
157
     */
    /*!
158
     * \ingroup PorousmediumflowModels
159
160
     * \defgroup RichardsNCModel Richards nc
     * \brief Richards multi-component flow
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
     * \copydetails ./porousmediumflow/tracer/model.hh
168
     */
169

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

194
/* ***************** Benchmarks and Tests ******************/
195
/*!
196
 * \defgroup BenchmarksAndTests Benchmarks and Tests
197
 * \brief Benchmarks and tests used for (automated) testing and demonstration purposes
198
 */
199
200
201
202
 	/*! 
 	 * \ingroup BenchmarksAndTests
 	 * \defgroup PorousmediumflowTests Porous-Medium Flow Tests
 	 * \brief Single and multi-phase tests for flow and transport in porous materials
203
 	 */
204
205
206
207
208
209
210
211
212
213
214
215
216
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 	 	/*! 
 	     * \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 Varios tests for single-phase Navier Stokes / Stokes tests
288
 	 */
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 	  	/*!  
 	     * \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. The files are listed below.
	 	 */
	/*!  
 	 * \ingroup BenchmarksAndTests
 	 * \defgroup MaterialTests Material system tests
 	 * \brief Benchmarks and Test(s) for the material system.
303
 	 */
304

305
/* ***************** Discretization ******************/
306
/*!
307
 * \defgroup Discretization Discretization schemes
308
 * \brief The discretization schemes available in DuMu<sup>x</sup>
309
 */
310
    /*!
311
     * \ingroup Discretization
312
     * \defgroup BoxDiscretization Box FV scheme
313
     * \brief The box method is a collocated finite volume scheme with control volumes centered at grid nodes.
314
315
     */
    /*!
316
     * \ingroup Discretization
317
     * \defgroup CCDiscretization Cell-centered FV scheme
318
     * \brief Finite volume schemes with degrees of freedom located at grid cell centers.
319
320
     */	
        /*!
321
         * \ingroup CCDiscretization
322
         * \defgroup CCTpfaDiscretization Two-point flux approximation (Tpfa)
323
         * \brief A cell-centered finite volume scheme with two-point flux approximation.
324
         */
325
        /*!
326
         * \ingroup CCDiscretization
327
         * \defgroup CCMpfaDiscretization Multi-point flux approximation (Mpfa)
328
         * \brief A cell-centered finite volume scheme with multi-point flux approximation.
329
330
         */
    /*!
331
     * \ingroup Discretization
332
     * \defgroup StaggeredDiscretization Staggered FV scheme
333
     * \brief A staggered finite volume scheme with degrees of freedom at cell-centers and facets.
334
335
     */

336
/* ***************** Material ******************/
337
/*!
338
 * \defgroup Material Material and Fluid Framework
339
340
 * \brief The DuMu<sup>x</sup> material and fluid framework with constitutive laws and physics
 * \par
341
342
 * Short description of the most important concepts of the material and fluid framework:
 *
343
344
345
346
347
348
349
350
351
 *  - __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
352
 */
353
	/*!
354
355
     * \ingroup Material
     * \defgroup Binarycoefficients Binary Coefficients
356
     * \brief Binary coefficients
357
     *
358
359
360
361
362
     *  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.
363
     */
364
365
366
    /*!
     * \ingroup Material
     * \defgroup Chemistry Chemistry
367
     * \brief Chemical reactions
368
     *
369
370
371
372
373
     * 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.
     */
374
375
376
    /*!
     * \ingroup Material
     * \defgroup Components Components
377
     * \brief Components: building blocks for fluid systems
378
     *
379
380
381
382
383
384
     * 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.
385
     */
386
		/*!
387
388
         * \ingroup Components
         * \defgroup IAPWS IAPWS
389
         * \brief Tabulated values according to the International Association for the Properties of Water and Steam (IAPWS)
390
         */
391
    /*!
392
     * \ingroup Material
393
     * \defgroup ConstraintSolver Constraint Solver
394
     * \brief Constraint solvers converting primary to secondary variables
395
     *
396
397
398
399
400
     * 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.
401
402
403
404
405
     * 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.
406
     */
407
408
409
    /*!
     * \ingroup Material
     * \defgroup EOS Equation of State
410
     * \brief Equations of state
411
     *
412
413
414
415
416
     * 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.
417
     */
418
419
    /*!
     * \ingroup Material
420
421
422
     * \defgroup fluidmatrixinteractions Fluid-Matrix Interactions
     * \brief e.g. pc-Sw, kr-Sw relations, effective diffusion coefficients
     *
423
424
425
426
427
     * 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.
     */
428
    /*!
Thomas Fetzer's avatar
Thomas Fetzer committed
429
430
     * \ingroup Material
     * \defgroup FluidStates Fluid States
431
     * \brief Fluid states are responsible for representing the
432
     * complete thermodynamic configuration of a system at a given spatial
433
434
435
     * and temporal position.
     *
     * A fluid state always provides access methods
436
437
438
439
440
     * 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.
441
442
443
444
     */
    /*!
     * \ingroup Material
     * \defgroup Fluidsystems Fluid Systems
445
446
447
448
449
450
451
     * \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
452
     */
453
454
455
    /*!
     * \ingroup Material
     * \defgroup SpatialParameters Spatial Parameters
456
457
     * \brief Parameters of the porous matrix and other parameter varying with position (e.g. porosity)
     *
458
459
460
     * 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.
461
     *
462
     */
463

464
465
466
/* ***************** Adaptive ******************/
/*!
 * \defgroup Adaptive Adaptive
467
 * \brief Adaptive grids
468
 */
469

470
471
472
/* ***************** Assembly ******************/
/*!
 * \defgroup Assembly Assembly
473
 * \brief Assembly of linear systems (Jacobian and residual)
474
 */
475

476
/* ***************** Common ******************/
477
/*!
478
 * \defgroup Common Common
479
 * \brief Common classes, functions, properties and concepts
480
 */
481
 	/*!
482
483
  	 * \ingroup Common
  	 * \defgroup Properties Properties
484
  	 * \brief Basic properties of all models in DuMu<sup>x</sup>
485
  	 */
486

487
488
489
/* ***************** InputOutput ******************/
/*!
 * \defgroup InputOutput Input Output
490
 * \brief Classes and functions dealing with input and output of data and grids
491
492
493
494
495
 */

/* ***************** Linear ******************/
/*!
 * \defgroup Linear Linear
496
 * \brief Linear solvers and helpers
497
498
499
500
501
 */

/* ***************** Nonlinear ******************/
/*!
 * \defgroup Nonlinear Nonlinear
502
 * \brief Nonlinear solvers: Newton method
503
504
505
506
507
 */

/* ***************** Parallel ******************/
/*!
 * \defgroup Parallel Parallel
508
 * \brief Helpers for parallel runs with MPI
509
 */