version 3.9-dev
Module documentation
Here is a list of all modules:
[detail level 12345]
 Mathematical modelsThe mathematical models implemented in DuMux
 Porous medium flow (Darcy)Single and multi-phase models for flow and transport in porous materials
 1pSingle-phase (immiscible) Darcy flow
 1pncSingle-phase, multi-component Darcy flow
 1pncminSingle-phase, multi-component Darcy flow with mineralization
 2pTwo-phase (immiscible) Darcy flow
 2p1cTwo-phase, one-component Darcy flow
 2p2cTwo-phase, two-component Darcy flow
 2pncTwo-phase, multi-component Darcy flow
 2pncminTwo-phase, multi-component Darcy flow with mineralization
 3pThree-phase (immiscible) Darcy flow
 3p3cThree-phase, three-component Darcy flow
 3pwateroilThree-phase, two-component Darcy flow with water (liquid & gas) and oil
 boxdfmVertex-centered, continuous-pressure, conforming lower-dimensional discrete-fracture model
 CO2Two-phase, two-component Darcy flow specialized for supercritical CO2 storage
 mineralizationModel adding components that can precipitate as a solid phase to a standard Darcy flow model
 mpncGeneralized multi-phase, multi-component Darcy flow
 nonequilibriumModel that adds nonequilibrium equations to another porous medium flow model (only used in MPNCModel currently)
 non-isothermalModel that adds an energy equation (thermal equilibrium) to another porous medium flow model
 RichardsRichards flow
 extended Richards' equationExtended Richards' equation
 Richards multi-componentRichards multi-component flow
 solid-energyEnergy equation for the solid (general heat equation)
 tracerMulti-component advection-diffusion-reaction model with given velocity field
 Free flow (Navier-Stokes)Single-phase models based on the Navier-Stokes equation
 Navier-StokesSingle-phase Navier-Stokes flow
 Reynolds-Averaged Navier-StokesSingle-phase Reynolds-Averaged Navier-Stokes flow
 CompositionalSingle-phase multi-component free-flow flow models
 NonisothermalAn energy equation adaptor for isothermal free-flow models
 Shallow water flowTwo-dimensional shallow water flow (depth-averaged)
 GeomechanicsModels taking into account solid deformation
 Solid mechanics w/o fluid pressureModels linear elastic deformation of a solid. Disregards fluid pressure
 Solid mechanics with fluid pressureModels linear elastic deformation of a solid. Takes fluid pressure into account
 Hyperelastic solid mechanics w/o fluid pressureModels nonlinear deformation of an elastic solid
 Pore networkSingle and multi-phase models for flow and transport in pore networks
 1pSingle-phase (immiscible) flow
 1pncSingle-phase, multi-component flow
 2pTwo-phase (immiscible) flow
 solidenergyEnergy equation for the solid (heat equation)
 Discretization schemesThe discretization schemes available in DuMux
 Cell-centered Finite Volume MethodsFinite volume schemes with degrees of freedom located at grid cell centers
 Two-point flux approximation (Tpfa)A cell-centered finite volume scheme with two-point flux approximation
 Multi-point flux approximation (Mpfa)A cell-centered finite volume scheme with multi-point flux approximation
 Control-volume Finite Element MethodsControl-volume finite element schemes (e.g. box method) Control-volume finite element schemes are based on finite element basis functions for interpolation but define control volumes to construct a finite volume scheme. They can be interpreted both as finite volume or as (Petrov-Galerkin) finite element scheme
 Diamond discretization schemeFace-centered finite-volume scheme based on non-conforming finite-element spaces
 Box FV schemeThe box method is a collocated finite volume scheme with control volumes centered at grid nodes
 PQ1 bubble schemeControl-volume finite element scheme based on P1/Q1 basis function with enrichment by a bubble function
 Staggered Grid Finite Volume MethodDiscretization for the momentum balance of the Navier-Stokes equations. Can be used to build a marker-and-cell scheme (MAC) together with Tpfa for the discretization of the mass balance equation
 Staggered FV schemeA staggered finite volume scheme with degrees of freedom at cell-centers and facets. In this implementation, momentum control volumes do not explicitly exist, but the implementation uses workarounds
 Finite Element MethodsThe finite element method
 Pore-network ModelsThe pore-network model discretization
 Properties and the property systems
 Parameters and runtime configuration
 Constitutive modelsConstitutive relations for fluids, solids, fluid-matrix interactions, and more
 Relations for binary mixturesBinary coefficients such as binary diffusion coefficients, Henry coefficients
 Chemical constitutive modelsChemical reaction models
 Thermodynamical properties of chemical speciesThermodynamical properties of single chemical species or fixed mixtures of species ( \( \text{CO}_2, \text{H}_2\text{O}, \text{Air}, ... \))
 IAPWSTabulated values according to the International Association for the Properties of Water and Steam (IAPWS)
 Constraint solvers for thermodynamic constraints of mixturesConstraint solvers converting primary to secondary variables
 Equations of StateThermodynamic equations relating state variables (e.g. temperature, pressure, density)
 Fluid-matrix interactionsConstitutive models for interaction of fluids and solids
 Effective diffusivity in porous mediaLaws for calculating effective diffusion coefficients
 Effective heat conductivity in porous mediaLaws for calculating effective heat conductivity coefficients
 Fluid StatesFluid states represent the thermodynamic configuration of a system
 Fluid SystemsFluid systems express the thermodynamic relations (functions)
 Solid StatesSolid states are responsible for representing all relevant thermodynamic quantities of solid systems
 Solid SystemsSolid systems express the thermodynamic relations (functions)
 Multidomain frameworkCoupling of several regular DuMux problems
 Boundary coupling modeCouples 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
 Darcy-Darcy domain couplingCouples domains with equal-dimension multi-physics problems in a Darcy-Darcy coupling
 Free flow-Pore network domain couplingCouples domains with equal-dimension multi-physics problems in a Free flow-Pore network coupling
 Free flow-Porous medium domain couplingCouples domains with equal-dimension multi-physics problems in a Free flow-Porous medium coupling
 Stokes-Darcy domain couplingCouples domains with equal-dimension multi-physics problems in a Stokes-Darcy coupling
 Coupling for dual network approach for pore network modelsCoupling for dual network approach for pore network models
 Embedded mixed-dimension coupling modeCouples 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
 Conforming mixed-dimension facet coupling modeCouples 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
 GeometryAlgorithms for geometry computations (intersections, distances, ...)
 Input OutputInput and output of data and grids
 Assembly and SolversAssembling matrices and vectors, solvers for linear and nonlinear equations
 AssemblyAssembly of linear systems (Jacobian and residual)
 LinearLinear solvers and helpers
 NonlinearNonlinear solvers: Newton method
 ParallelFiles for communication of parallel solvers
 TypetraitsBasic Type traits in DuMux
 CommonCommon functionality
 Numerical flux approximationsEverything flux related in DuMux
 Flux related to the box schemeFlux related to the box scheme
 Flux related to the CVFE schemeFlux related to control-volume finite element schemes
 Flux related to the cell-centered schemesFlux related to the cell-centered schemes
 Flux related to the cell-centered two-point flux approximation schemesFlux related to the cell-centered two-point flux approximation schemes
 Flux related to the cell-centered multi-point flux approximation schemesFlux related to the cell-centered multi-point flux approximation schemes
 Flux related to the face-centered diamond schemeFlux related to the face-centered diamond scheme
 Flux related to the pore network modelsFlux related to the pore newtwork models
 Flux related to the staggered schemeFlux related to the staggered scheme
 Flux related to the shallow water modelFlux related to the shallow water model
 Spatial parametersSpatial parameters
 Tools for adaptive gridsTools for simulations using adaptive grids
 ExperimentalExperimental features