modules.txt 16.2 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
 */
12
    /*!
13
14
15
16
17
18
19
20
21
     * \ingroup PorousmediumflowModels
     * \defgroup OnePModel 1p (one-phase Darcy flow)
     * \copydetails ./porousmediumflow/1p/model.hh
     */
       /*!
        * \ingroup OnePModel
        * \defgroup SequentialOnePModel Sequential
        * # Pressure
        * \copydetails ./porousmediumflow/1p/sequential/diffusion/cellcentered/pressure.hh
22
        *
23
24
25
26
27
28
29
30
        * # Velocity
        * \copydetails ./porousmediumflow/1p/sequential/diffusion/cellcentered/velocity.hh
        */
    /*!
     * \ingroup PorousmediumflowModels
     * \defgroup OnePNCModel 1pnc (one-phase, n-component Darcy flow)
     *
     * \copydetails ./porousmediumflow/1pnc/model.hh
31
     */
32
    /*!
33
34
     * \ingroup PorousmediumflowModels
     * \defgroup OnePNCMinModel 1pncmin (one-phase, n-component Darcy flow with mineralization)
35
     *
36
     * \copydetails ./porousmediumflow/1pncmin/model.hh
37
     */
38
    /*!
39
40
41
     * \ingroup PorousmediumflowModels
     * \defgroup TwoPModel 2p (two-phase Darcy flow)
     * \copydetails ./porousmediumflow/2p/model.hh
42
     */
43
        /*!
44
45
46
47
         * \ingroup TwoPModel
         * \defgroup SequentialTwoPModel Sequential
         * # Pressure
         * \copydetails ./porousmediumflow/2p/sequential/diffusion/cellcentered/pressure.hh
48
         *
49
50
         * # Velocity
         * \copydetails ./porousmediumflow/2p/sequential/diffusion/cellcentered/velocity.hh
51
         */
52
    /*!
53
     * \ingroup PorousmediumflowModels
54
55
     * \defgroup TwoPOneCModel 2p1c (two-phase, one-component Darcy flow)
     *
56
     * \copydetails ./porousmediumflow/2p1c/model.hh
57
     */
58
    /*!
59
60
61
     * \ingroup PorousmediumflowModels
     * \defgroup TwoPTwoCModel 2p2c (two-phase, two-component Darcy flow)
     * \copydetails ./porousmediumflow/2p2c/model.hh
62
     */
63
        /*!
64
65
66
67
         * \ingroup TwoPTwoCModel
         * \defgroup SequentialTwoPTwoCModel Sequential
         * # Pressure
         * \copydetails ./porousmediumflow/2p2c/sequential/fvpressure.hh
68
         *
69
70
         * # Velocity
         * \copydetails ./porousmediumflow/2p2c/sequential/fvtransport.hh
71
         */
72
    /*!
73
     * \ingroup PorousmediumflowModels
74
75
     * \defgroup TwoPNCModel 2pnc (two-phase, n-component Darcy flow)
     *
76
     * \copydetails ./porousmediumflow/2pnc/model.hh
77
78
     */
    /*!
79
     * \ingroup PorousmediumflowModels
80
81
     * \defgroup TwoPNCMinModel 2pncmin (two-phase, n-component Darcy flow with mineralization)
     *
82
     * \copydetails ./porousmediumflow/2pncmin/model.hh
83
     */
84
    /*!
85
     * \ingroup PorousmediumflowModels
86
87
     * \defgroup ThreePModel 3p (three-phase Darcy flow)
     *
88
     * \copydetails ./porousmediumflow/3p/model.hh
89
90
     */
    /*!
91
     * \ingroup PorousmediumflowModels
92
93
     * \defgroup ThreePThreeCModel 3p3c (three-phase, three-component Darcy flow)
     *
94
     * \copydetails ./porousmediumflow/3p3c/model.hh
95
     */
96
    /*!
97
     * \ingroup PorousmediumflowModels
98
99
     * \defgroup ThreePWaterOilModel 3pwateroil (three-phase, two-component Darcy flow)
     *
100
     * \copydetails ./porousmediumflow/3pwateroil/model.hh
101
     */
102
    /*!
103
     * \ingroup PorousmediumflowModels
104
     * \defgroup CO2Model CO2 (two-phase, two-component Darcy flow)
105
     *
106
     * \copydetails ./porousmediumflow/co2/model.hh
107
     */
108
    /*!
109
110
     * \ingroup PorousmediumflowModels
     * \defgroup MineralizationModel Mineralization (equation adding solid/mineralization-phases to a standard Darcy flow model)
111
     *
112
     * \copydetails ./porousmediumflow/mineralization/model.hh
113
     */
114
    /*!
115
116
     * \ingroup PorousmediumflowModels
     * \defgroup MPNCModel MpNc (m-phase, n-component Darcy flow)
117
     *
118
     * \copydetails ./porousmediumflow/mpnc/model.hh
119
120
     */
    /*!
121
122
     * \ingroup PorousmediumflowModels
     * \defgroup NIModel Non-isothermal (energy equation, to be added to an isothermal model)
123
     *
124
     * \copydetails ./porousmediumflow/non-isothermal/model.hh
125
     */
126
    /*!
127
128
     * \ingroup PorousmediumflowModels
     * \defgroup RichardsModel Richards (Richards flow)
129
     *
130
     * \copydetails ./porousmediumflow/richards/model.hh
131
132
     */
    /*!
133
134
     * \ingroup PorousmediumflowModels
     * \defgroup RichardsNCModel RichardsNC (n-component Richards flow)
135
     *
136
     * \copydetails ./porousmediumflow/richardsnc/model.hh
137
138
     */
    /*!
139
140
     * \ingroup PorousmediumflowModels
     * \defgroup TracerModel Tracer (adds tracer transport to a model)
141
     *
142
     * \copydetails ./porousmediumflow/tracer/model.hh
143
     */
144

145
/* ***************** FreeflowModels ******************/
146
/*!
147
 * \defgroup FreeflowModels Free Flow Models
148
 */
Thomas Fetzer's avatar
Thomas Fetzer committed
149
    /*!
150
151
     * \ingroup FreeflowModels
     * \defgroup NavierStokesModel NavierStokes (one-phase Navier-Stokes flow)
152
     *
153
     * \copydetails ./freeflow/navierstokes/model.hh
154
155
     */
    /*!
156
157
     * \ingroup FreeflowModels
     * \defgroup NavierStokesNCModel NavierStokesnc (one-phase, n-component Navier-Stokes flow)
158
     *
159
     * \copydetails ./freeflow/navierstokesnc/model.hh
160
     */
161
    /*!
162
163
     * \ingroup FreeflowModels
     * \defgroup NavierStokesNIModel Non-isothermal (energy equation, to be added to a isothermal NavierStokes model)
164
     *
165
     * \copydetails ./freeflow/non-isothermal/model.hh
166
     */
167

168
/* ***************** Benchmarks and Tests ******************/
169
/*!
170
171
 * \defgroup BenchmarksAndTests Benchmarks and Tests
 *  TODO: Doc me in modules.txt!
172
 */
173
174
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup OnePTests 1p (one phase) benchmarks and tests
175
 	 * OnePTests contain various tests using a OnePModel. The files are listed below, with hopefully self-explanatory names.
176
177
178
 	 */
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup OnePNCTests 1pnc (one phase, n-component) benchmarks and tests
179
 	 * OnePNCTests contain various tests using a OneNCPModel. The files are listed below, with hopefully self-explanatory names.
180
181
182
183
184
185
 	 */
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup OnePNCMinTests 1pncmin (one phase, n-component mineralization) benchmarks and tests
 	 */
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup TwoPTests 2p (two phase) benchmarks and tests
186
 	 * TwoPTests contain various tests using a TwoPModel. The files are listed below, with hopefully self-explanatory names.
187
188
189
190
191
192
 	 */
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup TwoPOneCTests 2p1c (two phase, one component) benchmarks and tests
 	 */
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup TwoPTwoCTests 2p2c (two phase, two component) benchmarks and tests
Johannes Hommel's avatar
Johannes Hommel committed
193
 	 * TwoPTwoCTests contain various tests using a TwoPTwoCModel. The files are listed below, with hopefully self-explanatory names.
194
195
196
 	 */
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup TwoPNCTests 2pnc (two phase, n-component) benchmarks and tests
197
 	 * TwoPNCTests contain a fuel cell test problem using the TwoPNCModel. The files are listed below.
198
199
200
 	 */
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup TwoPNCMinTests 2pncmin (two phase, n-component mineralization) benchmarks and tests
201
 	 * TwoPNCMinTests contain a salt dissolution test problem using the TwoPNCMinModel. The files are listed below.
202
203
204
 	 */
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup ThreePTests 3p (three phase) benchmarks and tests
Johannes Hommel's avatar
Johannes Hommel committed
205
 	 * ThreePTests contain various tests using a ThreePModel. The files are listed below, with hopefully self-explanatory names.
206
207
208
 	 */
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup ThreePThreeCTests 3p3c (three phase, three component) benchmarks and tests
Johannes Hommel's avatar
Johannes Hommel committed
209
 	 * ThreePThreeCTests contain various tests using a ThreePThreeCModel. The files are listed below, with hopefully self-explanatory names.
210
211
212
 	 */
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup ThreePWaterOilTests 3pwateroil (three phase, water oil) benchmarks and tests
Johannes Hommel's avatar
Johannes Hommel committed
213
 	 * ThreePWaterOilTests contain a SAGD test problem using the ThreePWaterOilModel. The files are listed below.
214
 	 */
215
216
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup CO2Tests CO2 (two phase, two component) benchmarks and tests
Johannes Hommel's avatar
Johannes Hommel committed
217
 	 * CO2Tests contain a CO2 injection test problem using the TwoPTwoCModel and heterogeneous spatial parameters. The files are listed below.
218
 	 */
219
220
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup MPNCTests MPNC (m phase, n-component) benchmarks and tests
221
 	 */
222
223
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup RichardsTests Richards benchmarks and tests
224
 	 * RichardsTests contain various tests using a RichardsModel. The files are listed below, with hopefully self-explanatory names.
225
 	 */
226
227
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup RichardsNCTests Richards n-component benchmarks and tests
228
 	 * RichardsNCTests contain a n-component transport problem in the unsaturated zone using the RichardsNCModel. The files are listed below.
229
 	 */
230
231
 	/*! \ingroup BenchmarksAndTests
 	 * \defgroup TracerTests Tracer benchmarks and tests
Johannes Hommel's avatar
Johannes Hommel committed
232
 	 * TracerTests contain various tests using a TracerModel. The files are listed below, with hopefully self-explanatory names.
233
 	 */
234

235
/* ***************** Discretization ******************/
236
/*!
237
 * \defgroup Discretization Discretization schemes
238
 */
239
    /*!
240
241
242
243
     * \ingroup Discretization
     * \defgroup BoxDiscretization Box finite volume scheme
     *
     * \copydetails ./discretization/box/properties.hh
244
245
     */
    /*!
246
247
248
249
250
251
     * \ingroup Discretization
     * \defgroup CCDiscretization Cell-centered finite volume scheme
     * # Tpfa
     * \copybrief ./discretization/cellcentered/tpfa/properties.hh
     * # Mpfa
     * \copybrief ./discretization/cellcentered/mpfa/properties.hh
252
253
     */
         /*!
254
255
256
257
         * \ingroup CCDiscretization
         * \defgroup CCTpfaDiscretization Cell-centered finite volume scheme with two-point flux-approximuation (Tpfa)
         *
         * \copydetails ./discretization/cellcentered/tpfa/properties.hh
258
259
         */
         /*!
260
261
262
263
         * \ingroup CCDiscretization
         * \defgroup CCMpfaDiscretization Cell-centered finite volume scheme with multi-point flux-approximuation (Mpfa)
         *
         * \copydetails ./discretization/cellcentered/mpfa/properties.hh
264
265
         */
    /*!
266
267
268
     * \ingroup Discretization
     * \defgroup StaggeredDiscretization Staggered finite volume scheme
     * \copydetails ./discretization/staggered/properties.hh
269
270
     */

271
/* ***************** Material ******************/
272
/*!
273
274
275
 * \defgroup Material Material and Fluid Framework
 * Short description of the most important concepts of the material and fluid framework:
 *
276
277
278
279
280
281
282
283
284
 *  - __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
285
 */
286
287
288
    /*!
     * \ingroup Material
     * \defgroup Binarycoefficients Binary Coefficients
289
290
291
292
293
     *  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.
294
     */
295
296
297
298
299
300
301
302
    /*!
     * \ingroup Material
     * \defgroup Chemistry Chemistry
     * 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.
     */
303
304
305
    /*!
     * \ingroup Material
     * \defgroup Components Components
306
307
308
309
310
311
     * 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.
312
     */
313
         /*!
314
315
316
         * \ingroup Components
         * \defgroup IAPWS IAPWS
         */
317
     /*!
318
     * \ingroup Material
319
     * \defgroup ConstraintSolver Constraint Solver
320
321
322
323
324
     * 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.
325
326
327
328
329
     * 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.
330
     */
331
332
333
    /*!
     * \ingroup Material
     * \defgroup EOS Equation of State
334
335
336
337
338
     * 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.
339
     */
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
    /*!
     * \ingroup Material
     *  \defgroup fluidmatrixinteractions 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.
     */
        /*!
         * \ingroup fluidmatrixinteractions
         *  \defgroup fluidmatrixinteractionslaws Laws for Fluid-Matrix Interactions
         */
         /*!
         * \ingroup fluidmatrixinteractions
         *  \defgroup fluidmatrixinteractionsparams Parameters for Fluid-Matrix Interactions
         */
356
    /*!
Thomas Fetzer's avatar
Thomas Fetzer committed
357
358
     * \ingroup Material
     * \defgroup FluidStates Fluid States
359
360
361
362
363
364
365
366
     * 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.
367
368
369
370
     */
    /*!
     * \ingroup Material
     * \defgroup Fluidsystems Fluid Systems
371
     * Fluid systems express the thermodynamic relations
372
373
374
375
376
377
    *  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!
Thomas Fetzer's avatar
Thomas Fetzer committed
378
     */
379
380
381
    /*!
     * \ingroup Material
     * \defgroup SpatialParameters Spatial Parameters
382
383
384
     * 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.
385
     *
386
     */
387

388
389
390
391
392
/* ***************** Adaptive ******************/
/*!
 * \defgroup Adaptive Adaptive
 *  TODO: Doc me in modules.txt!
 */
393

394
395
396
397
398
/* ***************** Assembly ******************/
/*!
 * \defgroup Assembly Assembly
 *  TODO: Doc me in modules.txt!
 */
399

400
/* ***************** Common ******************/
401
/*!
402
403
404
 * \defgroup Common Common
 *  TODO: Doc me in modules.txt!
 */
405
 	/*!
406
407
408
409
  	 * \ingroup Common
  	 * \defgroup Properties Properties
  	 * TODO: Doc me in modules.txt!
  	 */
410

411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
/* ***************** InputOutput ******************/
/*!
 * \defgroup InputOutput Input Output
 *  TODO: Doc me in modules.txt!
 */

/* ***************** Linear ******************/
/*!
 * \defgroup Linear Linear
 *  TODO: Doc me in modules.txt!
 */

/* ***************** Nonlinear ******************/
/*!
 * \defgroup Nonlinear Nonlinear
 *  TODO: Doc me in modules.txt!
 */

/* ***************** Parallel ******************/
/*!
 * \defgroup Parallel Parallel
 *  TODO: Doc me in modules.txt!
433
 */