3.3.0
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 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
71template<class TypeTag, class MyTypeTag>
72struct [[deprecated("BoundaryTypes will be removed after 3.3. Deduce boundary types from Problem.")]] BoundaryTypes { using type = UndefinedProperty; };
73
76template<class TypeTag, class MyTypeTag>
78
80template<class TypeTag, class MyTypeTag>
82
84// Basic properties regarding balance equations
86// TODO: Integrate UseMoles into BalanceEqOpts
87template<class TypeTag, class MyTypeTag>
88struct UseMoles { using type = UndefinedProperty; };
89template<class TypeTag, class MyTypeTag>
91template<class TypeTag, class MyTypeTag>
93
95// Properties used by finite volume schemes:
97template<class TypeTag, class MyTypeTag>
99
100template<class TypeTag, class MyTypeTag>
102template <class TypeTag, class MyTypeTag>
104
105template<class TypeTag, class MyTypeTag>
107template<class TypeTag, class MyTypeTag>
109template<class TypeTag, class MyTypeTag>
111template<class TypeTag, class MyTypeTag>
113template<class TypeTag, class MyTypeTag>
115template<class TypeTag, class MyTypeTag>
117template<class TypeTag, class MyTypeTag>
119template<class TypeTag, class MyTypeTag>
121template<class TypeTag, class MyTypeTag>
123
125// Additional properties used by the cell-centered mpfa schemes:
127template<class TypeTag, class MyTypeTag>
129template<class TypeTag, class MyTypeTag>
131template<class TypeTag, class MyTypeTag>
133
135// Properties used by models involving flow in porous media:
137template<class TypeTag, class MyTypeTag>
139template<class TypeTag, class MyTypeTag>
141template<class TypeTag, class MyTypeTag>
143template<class TypeTag, class MyTypeTag>
145template<class TypeTag, class MyTypeTag>
147template<class TypeTag, class MyTypeTag>
149template<class TypeTag, class MyTypeTag>
151
152template<class TypeTag, class MyTypeTag>
154template<class TypeTag, class MyTypeTag>
155struct FluidSystem { using type = UndefinedProperty; };
156template<class TypeTag, class MyTypeTag>
157struct FluidState { using type = UndefinedProperty; };
158template<class TypeTag, class MyTypeTag>
159struct SolidSystem { using type = UndefinedProperty; };
160template<class TypeTag, class MyTypeTag>
161struct SolidState { using type = UndefinedProperty; };
162template<class TypeTag, class MyTypeTag>
164template<class TypeTag, class MyTypeTag>
166template<class TypeTag, class MyTypeTag>
168template<class TypeTag, class MyTypeTag>
169struct Formulation { using type = UndefinedProperty; };
170// TODO: is this useful? -> everything is a constraint solver just a different type
171template<class TypeTag, class MyTypeTag>
173
174// When using the box method in a multi-phase context, an interface solver might be necessary
175template<class TypeTag, class MyTypeTag>
177
179// Additional properties used by the 2pnc and 2pncmin models:
181template<class TypeTag, class MyTypeTag>
182struct Chemistry { using type = UndefinedProperty; };
183template<class TypeTag, class MyTypeTag>
185
187// Additional properties used by the richards model
189template<class TypeTag, class MyTypeTag>
191
193// Additional properties used by the 3pwateroil model:
195template<class TypeTag, class MyTypeTag>
197
199// Properties used by geomechanical models:
201template<class TypeTag, class MyTypeTag>
202struct StressType { using type = UndefinedProperty; };
203
205// Properties used by the staggered-grid discretization method
207
208template<class TypeTag, class MyTypeTag>
210template<class TypeTag, class MyTypeTag>
211struct NumEqFace { using type = UndefinedProperty; };
212template<class TypeTag, class MyTypeTag>
214template<class TypeTag, class MyTypeTag>
216template<class TypeTag, class MyTypeTag>
218template<class TypeTag, class MyTypeTag>
220template<class TypeTag, class MyTypeTag>
222template<class TypeTag, class MyTypeTag>
224template<class TypeTag, class MyTypeTag>
226template<class TypeTag, class MyTypeTag>
227struct BaseEpsilon { using type = UndefinedProperty; };
228template<class TypeTag, class MyTypeTag>
230template<class TypeTag, class MyTypeTag>
232template<class TypeTag, class MyTypeTag>
234template<class TypeTag, class MyTypeTag>
236template<class TypeTag, class MyTypeTag>
238
240// Properties used by the mpnc model
242
243template<class TypeTag, class MyTypeTag>
245
247// Properties used by the nonequilibrium model
249template<class TypeTag, class MyTypeTag>
251template<class TypeTag, class MyTypeTag>
253template<class TypeTag, class MyTypeTag>
255template<class TypeTag, class MyTypeTag>
257template<class TypeTag, class MyTypeTag>
259template<class TypeTag, class MyTypeTag>
261template<class TypeTag, class MyTypeTag>
263template<class TypeTag, class MyTypeTag>
265template<class TypeTag, class MyTypeTag>
267
268template<class TypeTag, class MyTypeTag>
270template<class TypeTag, class MyTypeTag>
272
274// Properties used by free flow models
276
277template<class TypeTag, class MyTypeTag>
279
281// Properties used by multidomain simulations
283template<class TypeTag, class MyTypeTag>
285
287// Basic properties of sequential models:
289template<class TypeTag, class MyTypeTag>
291
292} // end namespace Properties
293} // end namespace Dumux
294
295#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
Stores the boundary types of a single degree of freedom.
Definition: common/properties.hh:72
Definition: common/properties.hh:77
TODO: Remove this property as soon as the decoupled models are integrated.
Definition: common/properties.hh:81
Property whether to use moles or kg as amount unit for balance equations.
Definition: common/properties.hh:88
The component balance index that should be replaced by the total mass/mole balance.
Definition: common/properties.hh:90
A class that collects options for the evaluation of the balance equations.
Definition: common/properties.hh:92
Stores the boundary types on an element.
Definition: common/properties.hh:98
Definition: common/properties.hh:101
Definition: common/properties.hh:103
The secondary variables within a sub-control volume.
Definition: common/properties.hh:106
The type for a global container for the volume variables.
Definition: common/properties.hh:108
If disabled, the volume variables are not stored (reduces memory, but is slower)
Definition: common/properties.hh:110
Container storing the different types of flux variables.
Definition: common/properties.hh:112
Stores data associated with flux vars.
Definition: common/properties.hh:114
The engine behind the global flux cache (how to fill caches for the stencil)
Definition: common/properties.hh:116
The global vector of flux variable containers.
Definition: common/properties.hh:118
specifies if data on flux vars should be saved (faster, but more memory consuming)
Definition: common/properties.hh:120
The grid variables object managing variable data on the grid (volvars/fluxvars cache)
Definition: common/properties.hh:122
The primary interaction volume type.
Definition: common/properties.hh:128
The secondary interaction volume type used e.g. on the boundaries.
Definition: common/properties.hh:130
The type used for the nodal index sets of the dual grid.
Definition: common/properties.hh:132
The local residual of the energy equation.
Definition: common/properties.hh:138
The type for the calculation the advective fluxes.
Definition: common/properties.hh:140
specifies if the parameters for the advective fluxes depend on the solution
Definition: common/properties.hh:142
The type for the calculation of the molecular diffusion fluxes.
Definition: common/properties.hh:144
specifies if the parameters for the diffusive fluxes depend on the solution
Definition: common/properties.hh:146
The type for the calculation of the heat conduction fluxes.
Definition: common/properties.hh:148
specifies if the parameters for the heat conduction fluxes depend on the solution
Definition: common/properties.hh:150
The type of the spatial parameters object.
Definition: common/properties.hh:153
The type of the fluid system to use.
Definition: common/properties.hh:155
The type of the fluid state to use.
Definition: common/properties.hh:157
The type of the solid system to use.
Definition: common/properties.hh:159
The type of the solid state to use.
Definition: common/properties.hh:161
The employed model for the computation of the effective diffusivity.
Definition: common/properties.hh:163
Model to be used for the calculation of the effective conductivity.
Definition: common/properties.hh:165
specifies the velocity calculation module to be used
Definition: common/properties.hh:167
The formulation of the model.
Definition: common/properties.hh:169
Whether to use a contraint solver for computing the secondary variables.
Definition: common/properties.hh:172
Definition: common/properties.hh:176
The chemistry class with which solves equlibrium reactions.
Definition: common/properties.hh:182
Set the mole fraction in the wetting or nonwetting phase.
Definition: common/properties.hh:184
Property for turning Richards into extended Richards.
Definition: common/properties.hh:190
reduces the phasestates to threePhases and wnPhaseOnly
Definition: common/properties.hh:196
The type used for the evaluation of stress tensors and forces.
Definition: common/properties.hh:202
The number of equations for cell-centered dofs.
Definition: common/properties.hh:209
The number of equations for face dofs.
Definition: common/properties.hh:211
The solution vector type for cell-centered dofs.
Definition: common/properties.hh:213
The solution vector type for face dofs.
Definition: common/properties.hh:215
Global vector containing face-related data.
Definition: common/properties.hh:217
The primary variables container type for cell-centered dofs.
Definition: common/properties.hh:219
The primary variables container type for face dofs.
Definition: common/properties.hh:221
Specifies the intersection mapper.
Definition: common/properties.hh:223
The hybrid primary variables container type.
Definition: common/properties.hh:225
A base epsilon for numerical differentiation, can contain multiple values.
Definition: common/properties.hh:227
Class containing local face-related data.
Definition: common/properties.hh:229
Class containing local boundary data.
Definition: common/properties.hh:231
A vector containing the solution for a face (similar to ElementSolution)
Definition: common/properties.hh:233
Switch on/off caching of face variables.
Definition: common/properties.hh:235
Specifies the order of the upwinding scheme (1 == first order, 2 == second order(tvd methods))
Definition: common/properties.hh:237
Definition: common/properties.hh:244
the formulation of the pressure e.g most wetting first
Definition: common/properties.hh:250
Definition: common/properties.hh:252
Definition: common/properties.hh:254
Definition: common/properties.hh:256
Definition: common/properties.hh:258
Definition: common/properties.hh:260
Definition: common/properties.hh:262
Definition: common/properties.hh:264
Definition: common/properties.hh:266
Definition: common/properties.hh:269
Definition: common/properties.hh:271
Returns whether to normalize the pressure term in the momentum balance or not.
Definition: common/properties.hh:278
Definition: common/properties.hh:284
Definition: common/properties.hh:290
a tag to mark properties as undefined
Definition: propertysystem.hh:36