modules.txt 23.6 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
     * For a detailed model description see porousmediumflow/1p/model.hh
18
     */
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
     * For a detailed model description see porousmediumflow/1pnc/model.hh
35
     */
36
    /*!
37
     * \ingroup PorousmediumflowModels
38
     * \defgroup OnePNCMinModel 1pncmin
39
     * \brief Single-phase, multi-component Darcy flow with mineralization
40
     * For a detailed model description see porousmediumflow/1pncmin/model.hh
41
     */
42
    /*!
43
     * \ingroup PorousmediumflowModels
44
     * \defgroup TwoPModel 2p
45
     * \brief Two-phase (immiscible) Darcy flow
46
     * For a detailed model description see 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
     * For a detailed model description see porousmediumflow/2p1c/model.hh
64
     */
65
    /*!
66
     * \ingroup PorousmediumflowModels
67
     * \defgroup TwoPTwoCModel 2p2c
68
     * \brief Two-phase, two-component Darcy flow
69
     * For a detailed model description see 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
     * For a detailed model description see porousmediumflow/2pnc/model.hh
87
88
     */
    /*!
89
     * \ingroup PorousmediumflowModels
90
     * \defgroup TwoPNCMinModel 2pncmin
91
     * \brief Two-phase, multi-component Darcy flow with mineralization
92
     * For a detailed model description see porousmediumflow/2pncmin/model.hh
93
     */
94
    /*!
95
     * \ingroup PorousmediumflowModels
96
     * \defgroup ThreePModel 3p
97
     * \brief Three-phase (immiscible) Darcy flow
98
     * For a detailed model description see porousmediumflow/3p/model.hh
99
100
     */
    /*!
101
     * \ingroup PorousmediumflowModels
102
     * \defgroup ThreePThreeCModel 3p3c
103
     * \brief Three-phase, three-component Darcy flow
104
     * For a detailed model description see 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
     * For a detailed model description see porousmediumflow/3pwateroil/model.hh
111
     */
112
113
114
    /*!
     * \ingroup PorousmediumflowModels
     * \defgroup BoxDFMModel boxdfm
115
     * \brief Vertex-centered, continuous-pressure, conforming lower-dimensional discrete-fracture model
116
     * For a detailed model description see porousmediumflow/boxdfm/model.hh
117
     */
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
     * For a detailed model description see 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
     * For a detailed model description see porousmediumflow/mineralization/model.hh
130
     */
131
    /*!
132
     * \ingroup PorousmediumflowModels
133
     * \defgroup MPNCModel mpnc
134
     * \brief Generalized multi-phase, multi-component Darcy flow
135
     *
136
     * For a detailed model description see 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
     * For a detailed model description see porousmediumflow/nonequilibrium/model.hh
143
     */
144
        /*!
145
146
         * \ingroup NonEquilibriumModel
         * \defgroup ThermalNonEquilibriumModel ThermalNonEquilibrium
147
         * \brief Model that adapts the energy localresidual to thermal nonequilibrium
148
         * For a detailed model description see porousmediumflow/nonequilibrium/thermal/localresidual.hh
149
         */
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
     * For a detailed model description see porousmediumflow/nonisothermal/model.hh
156
     */
157
    /*!
158
     * \ingroup PorousmediumflowModels
159
160
     * \defgroup RichardsModel Richards
     * \brief Richards flow
161
     * For a detailed model description see porousmediumflow/richards/model.hh
162
163
     */
    /*!
164
     * \ingroup PorousmediumflowModels
165
166
     * \defgroup RichardsNCModel Richards nc
     * \brief Richards multi-component flow
167
     * For a detailed model description see porousmediumflow/richardsnc/model.hh
168
     */
169
170
171
172
    /*!
     * \ingroup PorousmediumflowModels
     * \defgroup SolidEnergyModel Solid energy
     * \brief Energy equation for the solid (general heat equation)
173
     * For a detailed model description see porousmediumflow/solidenergy/model.hh
174
     */
175
    /*!
176
     * \ingroup PorousmediumflowModels
177
178
     * \defgroup TracerModel Tracer
     * \brief Multi-component advection-diffusion-reaction model with given velocity field
179
     * For a detailed model description see porousmediumflow/tracer/model.hh
180
     */
181

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

273
/* ***************** Discretization ******************/
274
/*!
275
 * \defgroup Discretization Discretization schemes
276
 * \brief The discretization schemes available in DuMu<sup>x</sup>
277
 */
278
    /*!
279
     * \ingroup Discretization
280
     * \defgroup BoxDiscretization Box FV scheme
281
     * \brief The box method is a collocated finite volume scheme with control volumes centered at grid nodes.
282
283
     */
    /*!
284
     * \ingroup Discretization
285
     * \defgroup CCDiscretization Cell-centered FV scheme
286
     * \brief Finite volume schemes with degrees of freedom located at grid cell centers.
287
     */
288
        /*!
289
         * \ingroup CCDiscretization
290
         * \defgroup CCTpfaDiscretization Two-point flux approximation (Tpfa)
291
         * \brief A cell-centered finite volume scheme with two-point flux approximation.
292
         */
293
        /*!
294
         * \ingroup CCDiscretization
295
         * \defgroup CCMpfaDiscretization Multi-point flux approximation (Mpfa)
296
         * \brief A cell-centered finite volume scheme with multi-point flux approximation.
297
298
         */
    /*!
299
     * \ingroup Discretization
300
     * \defgroup StaggeredDiscretization Staggered FV scheme
301
     * \brief A staggered finite volume scheme with degrees of freedom at cell-centers and facets.
302
     */
303
304
305
306
307
    /*!
     * \ingroup Discretization
     * \defgroup FEMDiscretization Finite element method
     * \brief The finite element method
     */
308
309
310
311
312
    /*!
     * \ingroup Discretization
     * \defgroup PoreNetworkDiscretization Pore network model discretization
     * \brief The pore-network model discretization.
     */
313
/* ***************** Flux ******************/
314
315
/*!
 * \defgroup Flux Flux
316
 * \brief Everything flux related in DuMu<sup>x</sup>
317
318
319
 */
    /*!
     * \ingroup Flux
Melanie Lipp's avatar
Melanie Lipp committed
320
     * \defgroup BoxFlux Flux related to the box scheme
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
     * \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
         */
338
339
340
341
342
    /*!
     * \ingroup Flux
     * \defgroup PoreNetworkFlux Flux related to the pore network models
     * \brief Flux related to the pore newtwork models
     */
343
344
345
346
347
    /*!
     * \ingroup Flux
     * \defgroup StaggeredFlux Flux related to the staggered scheme
     * \brief Flux related to the staggered scheme
     */
348
349
350
351
352
    /*!
     * \ingroup Flux
     * \defgroup ShallowWaterFlux Flux related to the shallow water model
     * \brief Flux related to the shallow water model
     */
353
/* ***************** Material ******************/
354
/*!
355
 * \defgroup Material Material and Fluid Framework
356
 * \brief The material and fluid framework with constitutive laws and mixture physics
357
 * \par
358
359
 * Short description of the most important concepts of the material and fluid framework:
 *
360
361
362
 *  - __Binary coefficient:__ <br>  @copydoc Binarycoefficients
 *  - __Chemistry:__ <br> @copydoc Chemistry
 *  - __Component:__ <br> @copydoc Components
363
 *  - __Constraint solvers:__ <br> @copydoc ConstraintSolvers
364
 *  - __Equation of state:__ <br> @copydoc EOS
365
 *  - __Fluid-Matrix Interactions:__ <br> @copydoc Fluidmatrixinteractions
366
 *  - __Fluid state:__ <br> @copydoc FluidStates
367
 *  - __Solid state:__ <br> @copydoc SolidStates
368
369
 *  - __Fluid system:__ <br> @copydoc Fluidsystems
 *  - __Spatial Parameters:__ <br> @copydoc SpatialParameters
Benjamin Faigle's avatar
 
Benjamin Faigle committed
370
 */
371
    /*!
372
373
     * \ingroup Material
     * \defgroup Binarycoefficients Binary Coefficients
374
     * \brief Binary coefficients
375
     *
376
377
378
379
380
     *  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.
381
     */
382
383
384
    /*!
     * \ingroup Material
     * \defgroup Chemistry Chemistry
385
     * \brief Chemical reactions
386
     *
387
388
389
390
391
     * 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.
     */
392
393
394
    /*!
     * \ingroup Material
     * \defgroup Components Components
Bernd Flemisch's avatar
Bernd Flemisch committed
395
     * \brief thermodynamics of single chemical species or fixed mixtures of species
396
     *
Bernd Flemisch's avatar
Bernd Flemisch committed
397
398
399
400
     * 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.
401
     */
402
        /*!
403
404
         * \ingroup Components
         * \defgroup IAPWS IAPWS
405
         * \brief Tabulated values according to the International Association for the Properties of Water and Steam (IAPWS)
406
         */
407
    /*!
408
     * \ingroup Material
409
     * \defgroup ConstraintSolvers Constraint Solvers
410
     * \brief Constraint solvers converting primary to secondary variables
411
     *
412
413
414
415
416
     * 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.
417
418
419
420
421
     * 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.
422
     */
423
424
425
    /*!
     * \ingroup Material
     * \defgroup EOS Equation of State
426
     * \brief Equations of state
427
     *
428
429
430
431
432
     * 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.
433
     */
434
435
    /*!
     * \ingroup Material
436
     * \defgroup Fluidmatrixinteractions Fluid-Matrix Interactions
437
438
     * \brief e.g. pc-Sw, kr-Sw relations, effective diffusion coefficients
     *
439
440
441
442
443
     * 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.
     */
444
    /*!
Thomas Fetzer's avatar
Thomas Fetzer committed
445
446
     * \ingroup Material
     * \defgroup FluidStates Fluid States
447
     * \brief Fluid states are responsible for representing the
448
     * complete thermodynamic configuration of a system at a given spatial
449
450
451
     * and temporal position.
     *
     * A fluid state always provides access methods
452
453
454
455
456
     * 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.
457
458
459
460
     */
    /*!
     * \ingroup Material
     * \defgroup Fluidsystems Fluid Systems
461
462
463
464
465
466
467
     * \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
468
     */
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
    /*!
     * \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!
     */
493
494
495
    /*!
     * \ingroup Material
     * \defgroup SpatialParameters Spatial Parameters
496
497
     * \brief Parameters of the porous matrix and other parameter varying with position (e.g. porosity)
     *
498
499
500
     * 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.
501
     *
502
     */
503

504
505
506
/* ***************** Adaptive ******************/
/*!
 * \defgroup Adaptive Adaptive
507
 * \brief Adaptive grids
508
 */
509

510
511
512
513
514
/* ***************** Assembly and Solvers ******************/
/*!
 * \defgroup AssemblyAndSolvers Assembly and Solvers
 * \brief Assembling matrices and vectors, solvers for linear and nonlinear equations
 */
Melanie Lipp's avatar
Melanie Lipp committed
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
    /*!
     * \ingroup AssemblyAndSolvers
     * \defgroup Assembly Assembly
     * \brief Assembly of linear systems (Jacobian and residual)
     */
    /*!
     * \ingroup AssemblyAndSolvers
     * \defgroup Linear Linear
     * \brief Linear solvers and helpers
     */
    /*!
     * \ingroup AssemblyAndSolvers
     * \defgroup Nonlinear Nonlinear
     * \brief Nonlinear solvers: Newton method
     */
    /*!
     * \ingroup AssemblyAndSolvers
     * \defgroup Parallel Parallel
     * \brief Files for communication of parallel solvers
     */
535
536

 /* ***************** Common ******************/
537
/*!
538
 * \defgroup Common Common
539
 * \brief Common classes, functions, properties and concepts
540
 */
541
542
543
544
545
546
547
548
549
550
    /*!
     * \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>
     */
551

552
553
554
/* ***************** InputOutput ******************/
/*!
 * \defgroup InputOutput Input Output
555
 * \brief Input and output of data and grids
556
557
 */

558
559
560
/* ***************** MultiDomain ******************/
/*!
 * \defgroup MultiDomain Multidomain simulations
561
 * \brief Coupling of several regular DuMu<sup>x</sup> problems
562
 *
563
 * The multi domain module allows coupling regular DuMu<sup>x</sup> problems.
564
565
 * Several coupling modes are currently available.
 */
566
567
568
569
570
    /*!
     * \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.
     */
571
572
573
574
575
576
577
578
579
580
        /*!
         * \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.
         */
581
582
583
584
585
586
587
588
589
590
    /*!
     * \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.
     */
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614

 /* ***************** PoreNetwork ******************/
 /*!
  * \defgroup PoreNetworkModels Pore-Network Models
  * \brief Single and multi-phase models for flow and transport in pore networks
  */
     /*!
      * \ingroup PoreNetworkModels
      * \defgroup PNMOnePModel 1p
      * \brief Single-phase (immiscible) flow
      * For a detailed model description see porenetwork/1p/model.hh
      */
     /*!
      * \ingroup PoreNetworkModels
      * \defgroup PNMOnePNCModel 1pnc
      * \brief Single-phase, multi-component flow
      * For a detailed model description see porenetwork/1pnc/model.hh
      */
     /*!
      * \ingroup PoreNetworkModels
      * \defgroup PNMTwoPModel 2p
      * \brief Two-phase (immiscible) flow
      * For a detailed model description see porenetwork/2p/model.hh
      */
615
616
617
618
619
620

 /* ***************** TimeStepping ******************/
 /*!
  * \defgroup TimeStepping Time stepping
  * \brief The time stepping
  */