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

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

57
/* ***************** Material ******************/
Benjamin Faigle's avatar
 
Benjamin Faigle committed
58
/*!
59
 * \defgroup Material Material Properties and Laws
Benjamin Faigle's avatar
 
Benjamin Faigle committed
60
 */
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
    /*!
     * \ingroup Material
     * \defgroup Binarycoefficients Binary Coefficients
     */
    /*!
     * \ingroup Material
     * \defgroup Components Components
     */
        /*!
         * \ingroup Components
         * \defgroup IAPWS IAPWS
         */
    /*!
     * \ingroup Material
     * \defgroup Fluidsystems Fluid Systems
     */
    /*!
     * \ingroup Material
     *  \defgroup fluidmatrixinteractions Fluid-Matrix Interactions
     */
        /*!
         * \ingroup fluidmatrixinteractions
         *  \defgroup fluidmatrixinteractionslaws Laws for Fluid-Matrix Interactions
         */
         /*!
         * \ingroup fluidmatrixinteractions
87
         *  \defgroup fluidmatrixinteractionsparams Parameters for Fluid-Matrix Interactions
88
89
90
91
92
         */
    /*!
     * \ingroup Material
     * \defgroup SpatialParameters Spatial Parameters
     */
93

94
/* ***************** Fully Implicit ******************/
95
/*!
96
 * \defgroup ImplicitModel Fully Implicit Scheme
97
 */
98
99
100
101
102
103
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitModels Models
     */
        /*!
         * \ingroup ImplicitModels
104
         * \defgroup OnePModel One-phase
105
         *
106
         * \copydetails Dumux::OnePModel
107
108
109
         */
        /*!
         * \ingroup ImplicitModels
110
         * \defgroup OnePTwoCModel One-phase Two-component
111
         *
112
         * \copydetails Dumux::OnePTwoCModel
113
114
115
116
117
118
119
120
121
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup RichardsModel Richards
         *
         * \copydetails Dumux::RichardsModel
         */
        /*!
         * \ingroup ImplicitModels
122
         * \defgroup TwoPModel Two-phase
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
         *
         * \copydetails Dumux::TwoPModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup TwoPNIModel Non-isothermal two-phase
         *
         * \copydetails Dumux::TwoPNIModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup TwoPTwoCModel Two-phase, two-component
         *
         * \copydetails Dumux::TwoPTwoCModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup TwoPTwoCNIModel Non-isothermal two-phase, two-component
         *
         * \copydetails Dumux::TwoPTwoCNIModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup CO2Model CO2
         *
         * \copydetails Dumux::CO2Model
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup CO2NIModel Non-isothermal CO2
         *
         * \copydetails Dumux::CO2NIModel
         */
        /*!
         * \ingroup ImplicitModels
158
         * \defgroup TwoPDFMModel Two-phase flow in discrete fracture-matrix
159
160
161
         *
         * \copydetails Dumux::TwoPDFMModel
         */
162
163
164
165
166
167
        /*!
         * \ingroup ImplicitModels
         * \defgroup ThreePModel Three-phase
         *
         * \copydetails Dumux::ThreePModel
         */
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
        /*!
         * \ingroup ImplicitModels
         * \defgroup ThreePThreeCModel Three-phase, three-component
         *
         * \copydetails Dumux::ThreePThreeCModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup ThreePThreeCNIModel Non-isothermal three-phase, three-component
         *
         * \copydetails Dumux::ThreePThreeCNIModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup MPNCModel M-phase N-component
         *
         * \copydetails Dumux::MPNCModel
         */
        /*!
         * \ingroup ImplicitModels
Thomas Fetzer's avatar
Thomas Fetzer committed
188
         * \defgroup NIModel Non-Isothermal
189
         *
Thomas Fetzer's avatar
Thomas Fetzer committed
190
         * \copydetails Dumux::NIModel
191
192
193
         */
        /*!
         * \ingroup ImplicitModels
Thomas Fetzer's avatar
Thomas Fetzer committed
194
         * \defgroup BoxStokesModel Stokes
195
         *
Thomas Fetzer's avatar
Thomas Fetzer committed
196
         * \copydetails Dumux::StokesModel
197
         */
198
199
200
201
202
203
204
205
206
207
208
209
         /*!
         * \ingroup ImplicitModels
         * \defgroup BoxStokesncModel N-component Stokes
         *
         * \copydetails Dumux::StokesncModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup BoxStokesncniModel Non-isothermal N-component Stokes
         *
         * \copydetails Dumux::StokesncniModel
         */
Hao Wu's avatar
Hao Wu committed
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
        /*!
         * \ingroup ImplicitModels
         * \defgroup BoxZeroEqModel ZeroEq
         *
         * \copydetails Dumux::ZeroEqModel
         */
         /*!
         * \ingroup ImplicitModels
         * \defgroup BoxZeroEqncModel N-component ZeroEq
         *
         * \copydetails Dumux::ZeroEqncModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup BoxZeroEqncniModel Non-isothermal N-component ZeroEq
         *
         * \copydetails Dumux::ZeroEqncniModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup BoxZeroEqModel ZeroEq
         *
         * \copydetails Dumux::ZeroEqModel
         */
         /*!
         * \ingroup ImplicitModels
         * \defgroup BoxZeroEqncModel N-component ZeroEq
         *
         * \copydetails Dumux::ZeroEqncModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup BoxZeroEqncniModel Non-isothermal N-component ZeroEq
         *
         * \copydetails Dumux::ZeroEqncniModel
         */
246
247
        /*!
         * \ingroup ImplicitModels
248
         * \defgroup ElasticBoxModel Linear elastic
249
250
251
252
253
         *
         * \copydetails Dumux::ElasticModel
         */
        /*!
         * \ingroup ImplicitModels
254
         * \defgroup ElOnePTwoCBoxModel One-phase two component linear elastic
255
256
257
258
259
         *
         * \copydetails Dumux::ElOnePTwoCModel
         */
        /*!
         * \ingroup ImplicitModels
260
         * \defgroup ElTwoPBoxModel Two-phase immiscible linear elastic
261
262
263
         *
         * \copydetails Dumux::ElTwoPModel
         */
Thomas Fetzer's avatar
Thomas Fetzer committed
264
265
266
267
268
269
270
271
        /*!
         * \ingroup ImplicitModels
         * \defgroup MultidomainModel Multidomain
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup TwoPTwoCStokesTwoCModel Two-component, Stokes-Darcy
         *
Hao Wu's avatar
Hao Wu committed
272
273
         * \copydetails Dumux::TwoCStokesTwoPTwoCLocalOperator
         * <br><br><br>
Thomas Fetzer's avatar
Thomas Fetzer committed
274
         * \copydetails Dumux::TwoPTwoCModel
Hao Wu's avatar
Hao Wu committed
275
         * <br>
Thomas Fetzer's avatar
Thomas Fetzer committed
276
277
278
279
280
281
         * \copydetails Dumux::StokesncModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup TwoPTwoCNIStokesTwoCNIModel Non-isothermal, two-component, Stokes-Darcy
         *
Hao Wu's avatar
Hao Wu committed
282
283
         * \copydetails Dumux::TwoCNIStokesTwoPTwoCNILocalOperator
         * <br><br><br>
Thomas Fetzer's avatar
Thomas Fetzer committed
284
         * \copydetails Dumux::TwoPTwoCNIModel
Hao Wu's avatar
Hao Wu committed
285
         * <br>
Thomas Fetzer's avatar
Thomas Fetzer committed
286
287
         * \copydetails Dumux::StokesncniModel
         */
Hao Wu's avatar
Hao Wu committed
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
        /*!
         * \ingroup ImplicitModels
         * \defgroup TwoPTwoCZeroEqTwoCModel Two-component, ZeroEq turbulence-Darcy
         *
         * \copydetails Dumux::TwoCStokesTwoPTwoCLocalOperator
         * <br><br><br>
         * \copydetails Dumux::TwoPTwoCModel
         * <br>
         * \copydetails Dumux::ZeroEqncModel
         */
        /*!
         * \ingroup ImplicitModels
         * \defgroup TwoPTwoCNIZeroEqTwoCNIModel Non-isothermal, two-component, ZeroEq turbulence-Darcy
         *
         * \copydetails Dumux::TwoCNIStokesTwoPTwoCNILocalOperator
         * <br><br><br>
         * \copydetails Dumux::TwoPTwoCNIModel
         * <br>
         * \copydetails Dumux::ZeroEqncniModel
         */
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
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitBaseProblems Base Problems
     */
    /*!
     * \ingroup ImplicitModel
     * \defgroup Discretizations Discretizations
     */
         /*!
         * \ingroup Discretizations
         * \defgroup CCModel Fully implicit cell-centered discretization
         */
         /*!
         * \ingroup Discretizations
         * \defgroup BoxModel Fully implicit box discretization
         */
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitBoundaryTypes Boundary Types
     */
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitFluxVariables Flux Variables
     */
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitIndices Indices
     */
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitLocalJacobian Local Jacobian
     */
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitLocalResidual Local Residual
     */
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitProperties Properties
     */
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitTestProblems Test Problems
     */
    /*!
     * \ingroup ImplicitModel
     * \defgroup ImplicitVolumeVariables Volume Variables
     */
356

357
/* ***************** Sequential ******************/
358
359
360
/*!
 * \defgroup Sequential Sequential Scheme: IMPET (Implicit Pressure Explicit Transport)
 */
361

362
363
364
    /*!
     * \ingroup Sequential
     * \defgroup IMPET Models
365
366
367
368
369
370
371
     */

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

372
373
374
        /*!
         * \ingroup IMPET
         * \defgroup OnePhase Single Phase (FV)
375
         */
376
377
378
379
380
381
382
            /*!
             * \ingroup OnePhase
             * \defgroup Pressure1p Pressure Equation
             */
                /*!
                 * \ingroup Pressure1p
                 * \defgroup FV1p Finite Volume
383
                 */
384
385
386
        /*!
         * \ingroup IMPET
         * \defgroup IMPES Immiscible IMPES
387
         */
388
389
390
391
392
393
394
            /*!
             * \ingroup IMPES
             * \defgroup Pressure2p Immiscible Pressure Equation
             */
                /*!
                 * \ingroup Pressure2p
                 * \defgroup FVPressure2p Finite Volume
395
                 */
396
397
398
                /*!
                * \ingroup Pressure2p
                * \defgroup MimeticPressure2p Mimetic Finite Differences
399
                */
400
401
402
403
404
405
406
            /*!
             * \ingroup IMPES
             * \defgroup Saturation2p Immiscible Saturation Transport
             */
                /*!
                 * \ingroup Saturation2p
                 * \defgroup FVSaturation2p Finite Volume
407
                 */
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
        /*!
         * \ingroup IMPET
         * \defgroup IMPEC Miscible (Compositional) IMPEC
         */
            /*!
             * \ingroup IMPEC
             * \defgroup multiphase Multiphase Compositional Models
             */
                /*!
                * \ingroup multiphase
                * \defgroup Adaptive2p2c (Grid-)Adaptive Multiphase Compositional Models
                */
            /*!
             * \ingroup IMPEC
             * \defgroup multiphysics Multiphysics Compositional Models
             */
    /*!
     * \ingroup Sequential
     * \defgroup IMPETproblems Base Problems
     */
    /*!
     * \ingroup Sequential
     * \defgroup IMPETProperties Properties
     */
    /*!
     * \ingroup Sequential
     * \defgroup IMPETtests Test Problems
     */
436