3.3.0
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
porousmediumflow/3p3c/model.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 *****************************************************************************/
78#ifndef DUMUX_3P3C_MODEL_HH
79#define DUMUX_3P3C_MODEL_HH
80
81#include <dune/common/fvector.hh>
82
90
95
96#include "indices.hh"
97#include "volumevariables.hh"
98#include "iofields.hh"
99#include "localresidual.hh"
100
101namespace Dumux {
102
108template<bool useCS, bool useMol>
110{
112
113 static constexpr int numEq() { return 3; }
114 static constexpr int numFluidPhases() { return 3; }
115 static constexpr int numFluidComponents() { return 3; }
116
117 static constexpr bool enableAdvection() { return true; }
118 static constexpr bool enableMolecularDiffusion() { return true; }
119 static constexpr bool enableEnergyBalance() { return false; }
120
121 static constexpr bool useConstraintSolver() { return useCS; }
122 static constexpr bool useMoles() { return useMol; }
123};
124
125namespace Properties {
126// Create new type tags
127namespace TTag {
129struct ThreePThreeC { using InheritsFrom = std::tuple<PorousMediumFlow>; };
131struct ThreePThreeCNI { using InheritsFrom = std::tuple<ThreePThreeC>; };
132} // end namespace TTag
133
135// Property values
137
139template<class TypeTag>
140struct BaseModelTraits<TypeTag, TTag::ThreePThreeC>
141{
142private:
144 static_assert(FluidSystem::numComponents == 3, "Only fluid systems with 3 components are supported by the 3p3c model!");
145 static_assert(FluidSystem::numPhases == 3, "Only fluid systems with 3 phases are supported by the 3p3c model!");
146public:
147 using type = ThreePThreeCModelTraits<getPropValue<TypeTag, Properties::UseConstraintSolver>(), getPropValue<TypeTag, Properties::UseMoles>()>;
148};
149template<class TypeTag>
150struct ModelTraits<TypeTag, TTag::ThreePThreeC> { using type = GetPropType<TypeTag, Properties::BaseModelTraits>; };
151
153template<class TypeTag>
154struct UseConstraintSolver<TypeTag, TTag::ThreePThreeC> { static constexpr bool value = false; };
155
157template<class TypeTag>
158struct ReplaceCompEqIdx<TypeTag, TTag::ThreePThreeC> { static constexpr int value = GetPropType<TypeTag, Properties::ModelTraits>::numFluidComponents(); };
165template<class TypeTag>
166struct FluidState<TypeTag, TTag::ThreePThreeC>{
167 private:
170 public:
172};
173
175template<class TypeTag>
176struct LocalResidual<TypeTag, TTag::ThreePThreeC> { using type = ThreePThreeCLocalResidual<TypeTag>; };
177
179template<class TypeTag>
180struct PrimaryVariables<TypeTag, TTag::ThreePThreeC>
181{
182private:
183 using PrimaryVariablesVector = Dune::FieldVector<GetPropType<TypeTag, Properties::Scalar>,
185public:
187};
188
190template<class TypeTag>
191struct VolumeVariables<TypeTag, TTag::ThreePThreeC>
192{
193private:
203
205 template<class BaseTraits, class DT, class EDM>
206 struct NCTraits : public BaseTraits
207 {
208 using DiffusionType = DT;
209 using EffectiveDiffusivityModel = EDM;
210 };
211
212public:
214};
215
217template<class TypeTag>
219
221template<class TypeTag>
222struct IOFields<TypeTag, TTag::ThreePThreeC> { using type = ThreePThreeCIOFields; };
223
225template<class TypeTag>
226struct UseMoles<TypeTag, TTag::ThreePThreeC> { static constexpr bool value = true; };
227
229// Property values for isothermal model required for the general non-isothermal model
231
233template<class TypeTag>
234struct ModelTraits<TypeTag, TTag::ThreePThreeCNI>
235{
236private:
238public:
240};
241
243template<class TypeTag>
244struct VolumeVariables<TypeTag, TTag::ThreePThreeCNI>
245{
246private:
255
259 template<class BaseTraits, class DT, class EDM, class ETCM>
260 struct NCNITraits : public BaseTraits
261 {
262 using DiffusionType = DT;
263 using EffectiveDiffusivityModel = EDM;
264 using EffectiveThermalConductivityModel = ETCM;
265 };
266public:
268};
269
271template<class TypeTag>
272struct IOFields<TypeTag, TTag::ThreePThreeCNI> { using type = EnergyIOFields<ThreePThreeCIOFields>; };
273
275template<class TypeTag>
277
278} // end namespace Properties
279} // end namespace Dumux
280
281#endif
Relation for the saturation-dependent effective thermal conductivity.
Relation for the saturation-dependent effective diffusion coefficient.
Represents all relevant thermodynamic quantities of a multi-phase, multi-component fluid system assum...
The base class for spatial parameters of multi-phase problems using a fully implicit discretization m...
A primary variable vector with a state to allow variable switches.
Definition: adapt.hh:29
typename Properties::Detail::GetPropImpl< TypeTag, Property >::type::type GetPropType
get the type alias defined in the property (equivalent to old macro GET_PROP_TYPE(....
Definition: propertysystem.hh:149
A vector of primary variables.
Definition: common/properties.hh:49
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
A class helping models to define input and output fields.
Definition: common/properties.hh:63
Definition: common/properties.hh:77
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
The secondary variables within a sub-control volume.
Definition: common/properties.hh:106
The type of the fluid state to use.
Definition: common/properties.hh:157
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
Whether to use a contraint solver for computing the secondary variables.
Definition: common/properties.hh:172
Relation for the saturation-dependent effective thermal conductivity.
Definition: somerton.hh:60
Relation for the saturation-dependent effective diffusion coefficient.
Definition: diffusivitymillingtonquirk.hh:51
Represents all relevant thermodynamic quantities of a multi-phase, multi-component fluid system assum...
Definition: compositional.hh:47
Traits class for the two-phase model.
Definition: porousmediumflow/3p/model.hh:106
The indices for the isothermal three-phase three-component model.
Definition: porousmediumflow/3p3c/indices.hh:35
Adds I/O fields specific to the three-phase three-component model.
Definition: porousmediumflow/3p3c/iofields.hh:38
Element-wise calculation of the Jacobian matrix for problems using the three-phase three-component fu...
Definition: porousmediumflow/3p3c/localresidual.hh:41
Specifies a number properties of two-phase models.
Definition: porousmediumflow/3p3c/model.hh:110
static constexpr bool useMoles()
Definition: porousmediumflow/3p3c/model.hh:122
static constexpr int numFluidComponents()
Definition: porousmediumflow/3p3c/model.hh:115
static constexpr int numFluidPhases()
Definition: porousmediumflow/3p3c/model.hh:114
static constexpr bool enableMolecularDiffusion()
Definition: porousmediumflow/3p3c/model.hh:118
static constexpr bool useConstraintSolver()
Definition: porousmediumflow/3p3c/model.hh:121
static constexpr bool enableAdvection()
Definition: porousmediumflow/3p3c/model.hh:117
static constexpr int numEq()
Definition: porousmediumflow/3p3c/model.hh:113
static constexpr bool enableEnergyBalance()
Definition: porousmediumflow/3p3c/model.hh:119
The type tags for the isothermal three-phase three-component model.
Definition: porousmediumflow/3p3c/model.hh:129
std::tuple< PorousMediumFlow > InheritsFrom
Definition: porousmediumflow/3p3c/model.hh:129
The type tags for the non-isothermal three-phase three-component model.
Definition: porousmediumflow/3p3c/model.hh:131
std::tuple< ThreePThreeC > InheritsFrom
Definition: porousmediumflow/3p3c/model.hh:131
GetPropType< TypeTag, Properties::BaseModelTraits > type
Definition: porousmediumflow/3p3c/model.hh:150
Contains the quantities which are are constant within a finite volume in the three-phase three-compon...
Definition: porousmediumflow/3p3c/volumevariables.hh:64
A primary variable vector with a state to allow variable switches.
Definition: switchableprimaryvariables.hh:38
Adds I/O fields specific to non-isothermal models.
Definition: porousmediumflow/nonisothermal/iofields.hh:39
Specifies a number properties of non-isothermal porous medium flow models based on the specifics of a...
Definition: porousmediumflow/nonisothermal/model.hh:70
Declares all properties used in Dumux.
Defines a type tag and some properties for models using the box scheme.
Adaption of the fully implicit scheme to the three-phase flow model.
The implicit non-isothermal model.
Adds I/O fields specific to non-isothermal models.
Adds I/O fields specific to the tracer model.
Element-wise calculation of the local residual for problems using fully implicit tracer model.
Base class for the model specific class which provides access to all volume averaged quantities.
Defines the indices used by the non-isothermal two-phase two-component model.
Defines the primary variable and equation indices used by the isothermal tracer model.