FlowBaseProblemProperties.hpp
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 This file is part of the Open Porous Media project (OPM).
5
6 OPM 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 2 of the License, or
9 (at your option) any later version.
10
11 OPM 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 OPM. If not, see <http://www.gnu.org/licenses/>.
18
19 Consult the COPYING file in the top-level source directory of this
20 module for the precise wording of the license and the list of
21 copyright holders.
22*/
28#ifndef OPM_FLOW_BASE_PROBLEM_PROPERTIES_HPP
29#define OPM_FLOW_BASE_PROBLEM_PROPERTIES_HPP
30
31
32#include <opm/material/thermal/EclThermalLawManager.hpp>
33
36
43
44#if HAVE_DAMARIS
46#endif
47
48#include <tuple>
49
50namespace Opm::Properties {
51
52namespace TTag {
53
55 using InheritsFrom = std::tuple<CpGridVanguard>;
56};
57
58}
59
60template<class TypeTag, class MyTypeTag>
62
63
64
65// The class which deals with ECL aquifers
66template<class TypeTag, class MyTypeTag>
68
69// Specify whether API tracking should be enabled (replaces PVT regions).
70// TODO: This is not yet implemented
71template<class TypeTag, class MyTypeTag>
73
74// Enable the additional checks even if compiled in debug mode (i.e., with the NDEBUG
75// macro undefined). Next to a slightly better performance, this also eliminates some
76// print statements in debug mode.
77template<class TypeTag, class MyTypeTag>
79
80// if thermal flux boundaries are enabled an effort is made to preserve the initial
81// thermal gradient specified via the TEMPVD keyword
82template<class TypeTag, class MyTypeTag>
84
85// The class which deals with wells
86template<class TypeTag, class MyTypeTag>
87struct WellModel { using type = UndefinedProperty; };
88
89// Tracer might be moved to the blackoil side
90// The class that deals with the tracer
91template<class TypeTag, class MyTypeTag>
93
94template <class TypeTag>
95struct TracerModel<TypeTag, TTag::FlowBaseProblem>
97
98// Select the element centered finite volume method as spatial discretization
99template<class TypeTag>
100struct SpatialDiscretizationSplice<TypeTag, TTag::FlowBaseProblem>
102
103// use automatic differentiation to linearize the system of PDEs
104template<class TypeTag>
105struct LocalLinearizerSplice<TypeTag, TTag::FlowBaseProblem>
107
108template<class TypeTag>
109struct BaseDiscretizationType<TypeTag, TTag::FlowBaseProblem>
111
112template<class TypeTag>
113struct DiscreteFunction<TypeTag, TTag::FlowBaseProblem>
114{
117};
118
119template<class TypeTag>
120struct GridView<TypeTag, TTag::FlowBaseProblem>
122
123// Set the material law for energy storage in rock
124template<class TypeTag>
125struct SolidEnergyLaw<TypeTag, TTag::FlowBaseProblem>
126{
127private:
130
131public:
132 using EclThermalLawManager = ::Opm::EclThermalLawManager<Scalar, FluidSystem>;
133
134 using type = typename EclThermalLawManager::SolidEnergyLaw;
135};
136
137// Set the material law for thermal conduction
138template<class TypeTag>
139struct ThermalConductionLaw<TypeTag, TTag::FlowBaseProblem>
140{
141private:
144
145public:
146 using EclThermalLawManager = ::Opm::EclThermalLawManager<Scalar, FluidSystem>;
147
148 using type = typename EclThermalLawManager::ThermalConductionLaw;
149};
150
151// use a slightly faster stencil class because it does not need the normals and
152// the integration points of intersections
153template<class TypeTag>
154struct Stencil<TypeTag, TTag::FlowBaseProblem>
155{
156private:
159
160public:
161 using type = EcfvStencil<Scalar,
162 GridView,
163 /*needIntegrationPos=*/false,
164 /*needNormal=*/false>;
165};
166
167// by default use the dummy aquifer "model"
168template<class TypeTag>
169struct AquiferModel<TypeTag, TTag::FlowBaseProblem> {
171};
172
173// Enable diffusion
174template<class TypeTag>
175struct EnableDiffusion<TypeTag, TTag::FlowBaseProblem>
176{ static constexpr bool value = true; };
177
178// Disable dispersion
179template<class TypeTag>
180struct EnableDispersion<TypeTag, TTag::FlowBaseProblem>
181{ static constexpr bool value = false; };
182
183// Enable Convective Mixing
184template<class TypeTag>
185struct EnableConvectiveMixing<TypeTag, TTag::FlowBaseProblem>
186{ static constexpr bool value = true; };
187
188// disable API tracking
189template<class TypeTag>
190struct EnableApiTracking<TypeTag, TTag::FlowBaseProblem>
191{ static constexpr bool value = false; };
192
193// store temperature (but do not conserve energy, as long as EnableEnergy is false)
194template<class TypeTag>
195struct EnableTemperature<TypeTag, TTag::FlowBaseProblem>
196{ static constexpr bool value = true; };
197
198template<class TypeTag>
199struct EnableMech<TypeTag, TTag::FlowBaseProblem>
200{ static constexpr bool value = false; };
201
202// disable all extensions supported by black oil model. this should not really be
203// necessary but it makes things a bit more explicit
204template<class TypeTag>
205struct EnablePolymer<TypeTag, TTag::FlowBaseProblem>
206{ static constexpr bool value = false; };
207
208template<class TypeTag>
209struct EnableSolvent<TypeTag, TTag::FlowBaseProblem>
210{ static constexpr bool value = false; };
211
212template<class TypeTag>
213struct EnableEnergy<TypeTag, TTag::FlowBaseProblem>
214{ static constexpr bool value = false; };
215
216template<class TypeTag>
217struct EnableFoam<TypeTag, TTag::FlowBaseProblem>
218{ static constexpr bool value = false; };
219
220template<class TypeTag>
221struct EnableExtbo<TypeTag, TTag::FlowBaseProblem>
222{ static constexpr bool value = false; };
223
224template<class TypeTag>
225struct EnableMICP<TypeTag, TTag::FlowBaseProblem>
226{ static constexpr bool value = false; };
227
228// disable thermal flux boundaries by default
229template<class TypeTag>
230struct EnableThermalFluxBoundaries<TypeTag, TTag::FlowBaseProblem>
231{ static constexpr bool value = false; };
232
233// By default, simulators derived from the FlowBaseProblem are production simulators,
234// i.e., experimental features must be explicitly enabled at compile time
235template<class TypeTag>
236struct EnableExperiments<TypeTag, TTag::FlowBaseProblem>
237{ static constexpr bool value = false; };
238
239// By default, we enable the debugging checks if we're compiled in debug mode
240template<class TypeTag>
241struct EnableDebuggingChecks<TypeTag, TTag::FlowBaseProblem>
242{ static constexpr bool value = true; };
243
244} // namespace Opm::Properties
245
246#endif // OPM_BASE_FLOW_PROBLEM_PROPERTIES_HPP
The base class which specifies the API of aquifer models.
Definition: BaseAquiferModel.hpp:50
Represents the stencil (finite volume geometry) of a single element in the ECFV discretization.
Definition: ecfvstencil.hh:69
Definition: fvbasediscretization.hh:350
The base class for the finite volume discretization schemes without adaptation.
Definition: fvbasediscretization.hh:1952
The base class for the finite volume discretization schemes.
Definition: fvbasediscretization.hh:298
A class which handles tracers as specified in by ECL.
Definition: TracerModel.hpp:75
Definition: blackoilmodel.hh:79
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:233
The Opm property system, traits with inheritance.
Definition: FlowBaseProblemProperties.hpp:67
Definition: fvbasediscretization.hh:272
typename BaseDiscretization::BlockVectorWrapper type
Definition: FlowBaseProblemProperties.hpp:116
Definition: fvbaseproperties.hh:77
Definition: FlowBaseProblemProperties.hpp:72
Enable convective mixing?
Definition: multiphasebaseproperties.hh:99
Definition: FlowBaseProblemProperties.hpp:78
Enable diffusive fluxes?
Definition: multiphasebaseproperties.hh:91
Enable dispersive fluxes?
Definition: multiphasebaseproperties.hh:95
Specify whether energy should be considered as a conservation quantity or not.
Definition: multiphasebaseproperties.hh:87
Specify if experimental features should be enabled or not.
Definition: fvbaseproperties.hh:241
Enable the ECL-blackoil extension for extended BO. ("Second gas" - alternative approach)
Definition: blackoilproperties.hh:47
Enable the ECL-blackoil extension for foam.
Definition: blackoilproperties.hh:63
Enable the ECL-blackoil extension for MICP.
Definition: blackoilproperties.hh:83
Definition: blackoilproperties.hh:91
Enable the ECL-blackoil extension for polymer.
Definition: blackoilproperties.hh:51
Enable the ECL-blackoil extension for solvents. ("Second gas")
Definition: blackoilproperties.hh:43
Definition: blackoilproperties.hh:88
Definition: FlowBaseProblemProperties.hpp:83
typename GetPropType< TypeTag, Properties::Grid >::LeafGridView type
Definition: FlowBaseProblemProperties.hpp:121
Definition: basicproperties.hh:103
Definition: fvbaseproperties.hh:55
Definition: FlowBaseProblemProperties.hpp:61
typename EclThermalLawManager::SolidEnergyLaw type
Definition: FlowBaseProblemProperties.hpp:134
::Opm::EclThermalLawManager< Scalar, FluidSystem > EclThermalLawManager
Definition: FlowBaseProblemProperties.hpp:132
The material law for the energy stored in the solid matrix.
Definition: multiphasebaseproperties.hh:63
The splice to be used for the spatial discretization.
Definition: multiphasebaseproperties.hh:39
The class describing the stencil of the spatial discretization.
Definition: fvbaseproperties.hh:70
Definition: fvbaseadlocallinearizer.hh:58
Definition: ecfvproperties.hh:41
Definition: FlowBaseProblemProperties.hpp:54
std::tuple< CpGridVanguard > InheritsFrom
Definition: FlowBaseProblemProperties.hpp:55
::Opm::EclThermalLawManager< Scalar, FluidSystem > EclThermalLawManager
Definition: FlowBaseProblemProperties.hpp:146
typename EclThermalLawManager::ThermalConductionLaw type
Definition: FlowBaseProblemProperties.hpp:148
The material law for thermal conduction.
Definition: multiphasebaseproperties.hh:71
Definition: FlowBaseProblemProperties.hpp:92
a tag to mark properties as undefined
Definition: propertysystem.hh:38
Definition: FlowBaseProblemProperties.hpp:87