3.4
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
common/properties.hh
Go to the documentation of this file.
1// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2// vi: set et ts=4 sw=4 sts=4:
3/*****************************************************************************
4 * See the file COPYING for full copying permissions. *
5 * *
6 * This program is free software: you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation, either version 3 of the License, or *
9 * (at your option) any later version. *
10 * *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
18 *****************************************************************************/
27#ifndef DUMUX_PROPERTIES_HH
28#define DUMUX_PROPERTIES_HH
29
30// explicitly guard the include so that the property system
31// header doesn't need to be opened and checked all the time
32#ifndef DUMUX_PROPERTY_SYSTEM_HH
34#endif // DUMUX_PROPERTY_SYSTEM_HH
35
36namespace Dumux {
37namespace Properties {
38
40// Basic properties of numeric models:
42template<class TypeTag, class MyTypeTag>
43struct Scalar { using type = UndefinedProperty; };
44template<class TypeTag, class MyTypeTag>
46template<class TypeTag, class MyTypeTag>
47struct Grid { using type = UndefinedProperty; };
48template<class TypeTag, class MyTypeTag>
50template<class TypeTag, class MyTypeTag>
51struct [[deprecated("NumEqVector will be removed after 3.4. Implemented in dumux/common/numeqvector.hh instead.")]] NumEqVector { using type = UndefinedProperty; };
52template<class TypeTag, class MyTypeTag>
53struct ModelTraits { using type = UndefinedProperty; };
54template<class TypeTag, class MyTypeTag>
56template<class TypeTag, class MyTypeTag>
57struct Problem { using type = UndefinedProperty; };
58template<class TypeTag, class MyTypeTag>
59struct PointSource { using type = UndefinedProperty; };
60template<class TypeTag, class MyTypeTag>
62template<class TypeTag, class MyTypeTag>
63struct IOFields { using type = UndefinedProperty; };
64template<class TypeTag, class MyTypeTag>
66template<class TypeTag, class MyTypeTag>
68template<class TypeTag, class MyTypeTag>
70
73template<class TypeTag, class MyTypeTag>
75
77template<class TypeTag, class MyTypeTag>
79
81// Basic properties regarding balance equations
83// TODO: Integrate UseMoles into BalanceEqOpts
84template<class TypeTag, class MyTypeTag>
85struct UseMoles { using type = UndefinedProperty; };
86template<class TypeTag, class MyTypeTag>
88template<class TypeTag, class MyTypeTag>
90
92// Properties used by finite volume schemes:
94template<class TypeTag, class MyTypeTag>
96
97template<class TypeTag, class MyTypeTag>
99template <class TypeTag, class MyTypeTag>
101
102template<class TypeTag, class MyTypeTag>
104template<class TypeTag, class MyTypeTag>
106template<class TypeTag, class MyTypeTag>
108template<class TypeTag, class MyTypeTag>
110template<class TypeTag, class MyTypeTag>
112template<class TypeTag, class MyTypeTag>
114template<class TypeTag, class MyTypeTag>
116template<class TypeTag, class MyTypeTag>
118template<class TypeTag, class MyTypeTag>
120
122// Additional properties used by the cell-centered mpfa schemes:
124template<class TypeTag, class MyTypeTag>
126template<class TypeTag, class MyTypeTag>
128template<class TypeTag, class MyTypeTag>
130
132// Properties used by models involving flow in porous media:
134template<class TypeTag, class MyTypeTag>
136template<class TypeTag, class MyTypeTag>
138template<class TypeTag, class MyTypeTag>
140template<class TypeTag, class MyTypeTag>
142template<class TypeTag, class MyTypeTag>
144template<class TypeTag, class MyTypeTag>
146template<class TypeTag, class MyTypeTag>
148
149template<class TypeTag, class MyTypeTag>
151template<class TypeTag, class MyTypeTag>
152struct FluidSystem { using type = UndefinedProperty; };
153template<class TypeTag, class MyTypeTag>
154struct FluidState { using type = UndefinedProperty; };
155template<class TypeTag, class MyTypeTag>
156struct SolidSystem { using type = UndefinedProperty; };
157template<class TypeTag, class MyTypeTag>
158struct SolidState { using type = UndefinedProperty; };
159template<class TypeTag, class MyTypeTag>
161template<class TypeTag, class MyTypeTag>
163template<class TypeTag, class MyTypeTag>
165template<class TypeTag, class MyTypeTag>
166struct Formulation { using type = UndefinedProperty; };
167// TODO: is this useful? -> everything is a constraint solver just a different type
168template<class TypeTag, class MyTypeTag>
170
171// When using the box method in a multi-phase context, an interface solver might be necessary
172template<class TypeTag, class MyTypeTag>
174
176// Additional properties used by the 2pnc and 2pncmin models:
178template<class TypeTag, class MyTypeTag>
179struct Chemistry { using type = UndefinedProperty; };
180template<class TypeTag, class MyTypeTag>
182
184// Additional properties used by the richards model
186template<class TypeTag, class MyTypeTag>
188
190// Additional properties used by the 3pwateroil model:
192template<class TypeTag, class MyTypeTag>
194
196// Properties used by geomechanical models:
198template<class TypeTag, class MyTypeTag>
199struct StressType { using type = UndefinedProperty; };
200
202// Properties used by the staggered-grid discretization method
204
205template<class TypeTag, class MyTypeTag>
207template<class TypeTag, class MyTypeTag>
208struct NumEqFace { using type = UndefinedProperty; };
209template<class TypeTag, class MyTypeTag>
211template<class TypeTag, class MyTypeTag>
213template<class TypeTag, class MyTypeTag>
215template<class TypeTag, class MyTypeTag>
217template<class TypeTag, class MyTypeTag>
219template<class TypeTag, class MyTypeTag>
221template<class TypeTag, class MyTypeTag>
223template<class TypeTag, class MyTypeTag>
224struct BaseEpsilon { using type = UndefinedProperty; };
225template<class TypeTag, class MyTypeTag>
227template<class TypeTag, class MyTypeTag>
229template<class TypeTag, class MyTypeTag>
231template<class TypeTag, class MyTypeTag>
233template<class TypeTag, class MyTypeTag>
235
237// Properties used by the mpnc model
239
240template<class TypeTag, class MyTypeTag>
242
244// Properties used by the nonequilibrium model
246template<class TypeTag, class MyTypeTag>
248template<class TypeTag, class MyTypeTag>
250template<class TypeTag, class MyTypeTag>
252template<class TypeTag, class MyTypeTag>
254template<class TypeTag, class MyTypeTag>
256template<class TypeTag, class MyTypeTag>
258template<class TypeTag, class MyTypeTag>
260template<class TypeTag, class MyTypeTag>
262template<class TypeTag, class MyTypeTag>
264
265template<class TypeTag, class MyTypeTag>
267template<class TypeTag, class MyTypeTag>
269
271// Properties used by free flow models
273
274template<class TypeTag, class MyTypeTag>
276template<class TypeTag, class MyTypeTag>
278
280// Properties used by multidomain simulations
282template<class TypeTag, class MyTypeTag>
284
286// Basic properties of sequential models:
288template<class TypeTag, class MyTypeTag>
290
291} // end namespace Properties
292} // end namespace Dumux
293
294#endif
The Dumux property system, traits with inheritance.
Definition: adapt.hh:29
Property to specify the type of scalar values.
Definition: common/properties.hh:43
Property which defines the group that is queried for parameters by default.
Definition: common/properties.hh:45
The DUNE grid type.
Definition: common/properties.hh:47
A vector of primary variables.
Definition: common/properties.hh:49
A vector of size number equations that can be used for Neumann fluxes, sources, residuals,...
Definition: common/properties.hh:51
Traits class encapsulating model specifications.
Definition: common/properties.hh:53
Model traits to be used as a base for nonisothermal, mineralization ... models.
Definition: common/properties.hh:55
Property to specify the type of a problem which has to be solved.
Definition: common/properties.hh:57
Property defining the type of point source used.
Definition: common/properties.hh:59
Property defining the class that computes which sub control volume point sources belong to.
Definition: common/properties.hh:61
A class helping models to define input and output fields.
Definition: common/properties.hh:63
The type of the base class of the local residual (specific to a discretization scheme)
Definition: common/properties.hh:65
Type of the global jacobian matrix.
Definition: common/properties.hh:67
Vector containing all primary variable vector of the grid.
Definition: common/properties.hh:69
Definition: common/properties.hh:74
TODO: Remove this property as soon as the decoupled models are integrated.
Definition: common/properties.hh:78
Property whether to use moles or kg as amount unit for balance equations.
Definition: common/properties.hh:85
The component balance index that should be replaced by the total mass/mole balance.
Definition: common/properties.hh:87
A class that collects options for the evaluation of the balance equations.
Definition: common/properties.hh:89
Stores the boundary types on an element.
Definition: common/properties.hh:95
Definition: common/properties.hh:98
Definition: common/properties.hh:100
The secondary variables within a sub-control volume.
Definition: common/properties.hh:103
The type for a global container for the volume variables.
Definition: common/properties.hh:105
If disabled, the volume variables are not stored (reduces memory, but is slower)
Definition: common/properties.hh:107
Container storing the different types of flux variables.
Definition: common/properties.hh:109
Stores data associated with flux vars.
Definition: common/properties.hh:111
The engine behind the global flux cache (how to fill caches for the stencil)
Definition: common/properties.hh:113
The global vector of flux variable containers.
Definition: common/properties.hh:115
specifies if data on flux vars should be saved (faster, but more memory consuming)
Definition: common/properties.hh:117
The grid variables object managing variable data on the grid (volvars/fluxvars cache)
Definition: common/properties.hh:119
The primary interaction volume type.
Definition: common/properties.hh:125
The secondary interaction volume type used e.g. on the boundaries.
Definition: common/properties.hh:127
The type used for the nodal index sets of the dual grid.
Definition: common/properties.hh:129
The local residual of the energy equation.
Definition: common/properties.hh:135
The type for the calculation the advective fluxes.
Definition: common/properties.hh:137
specifies if the parameters for the advective fluxes depend on the solution
Definition: common/properties.hh:139
The type for the calculation of the molecular diffusion fluxes.
Definition: common/properties.hh:141
specifies if the parameters for the diffusive fluxes depend on the solution
Definition: common/properties.hh:143
The type for the calculation of the heat conduction fluxes.
Definition: common/properties.hh:145
specifies if the parameters for the heat conduction fluxes depend on the solution
Definition: common/properties.hh:147
The type of the spatial parameters object.
Definition: common/properties.hh:150
The type of the fluid system to use.
Definition: common/properties.hh:152
The type of the fluid state to use.
Definition: common/properties.hh:154
The type of the solid system to use.
Definition: common/properties.hh:156
The type of the solid state to use.
Definition: common/properties.hh:158
The employed model for the computation of the effective diffusivity.
Definition: common/properties.hh:160
Model to be used for the calculation of the effective conductivity.
Definition: common/properties.hh:162
specifies the velocity calculation module to be used
Definition: common/properties.hh:164
The formulation of the model.
Definition: common/properties.hh:166
Whether to use a contraint solver for computing the secondary variables.
Definition: common/properties.hh:169
Definition: common/properties.hh:173
The chemistry class with which solves equlibrium reactions.
Definition: common/properties.hh:179
Set the mole fraction in the wetting or nonwetting phase.
Definition: common/properties.hh:181
Property for turning Richards into extended Richards.
Definition: common/properties.hh:187
reduces the phasestates to threePhases and wnPhaseOnly
Definition: common/properties.hh:193
The type used for the evaluation of stress tensors and forces.
Definition: common/properties.hh:199
The number of equations for cell-centered dofs.
Definition: common/properties.hh:206
The number of equations for face dofs.
Definition: common/properties.hh:208
The solution vector type for cell-centered dofs.
Definition: common/properties.hh:210
The solution vector type for face dofs.
Definition: common/properties.hh:212
Global vector containing face-related data.
Definition: common/properties.hh:214
The primary variables container type for cell-centered dofs.
Definition: common/properties.hh:216
The primary variables container type for face dofs.
Definition: common/properties.hh:218
Specifies the intersection mapper.
Definition: common/properties.hh:220
The hybrid primary variables container type.
Definition: common/properties.hh:222
A base epsilon for numerical differentiation, can contain multiple values.
Definition: common/properties.hh:224
Class containing local face-related data.
Definition: common/properties.hh:226
Class containing local boundary data.
Definition: common/properties.hh:228
A vector containing the solution for a face (similar to ElementSolution)
Definition: common/properties.hh:230
Switch on/off caching of face variables.
Definition: common/properties.hh:232
Specifies the order of the upwinding scheme (1 == first order, 2 == second order(tvd methods))
Definition: common/properties.hh:234
Definition: common/properties.hh:241
the formulation of the pressure e.g most wetting first
Definition: common/properties.hh:247
Definition: common/properties.hh:249
Definition: common/properties.hh:251
Definition: common/properties.hh:253
Definition: common/properties.hh:255
Definition: common/properties.hh:257
Definition: common/properties.hh:259
Definition: common/properties.hh:261
Definition: common/properties.hh:263
Definition: common/properties.hh:266
Definition: common/properties.hh:268
Returns whether to normalize the pressure term in the momentum balance or not.
Definition: common/properties.hh:275
The type for the calculation of the (turbulent) viscous (momentum) fluxes.
Definition: common/properties.hh:277
Definition: common/properties.hh:283
Definition: common/properties.hh:289
a tag to mark properties as undefined
Definition: propertysystem.hh:35