My Project
checkFluidSystem.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*/
27#ifndef OPM_CHECK_FLUIDSYSTEM_HPP
28#define OPM_CHECK_FLUIDSYSTEM_HPP
29
30#include <opm/common/utility/Demangle.hpp>
31
32// include all fluid systems in opm-material
41
42// include all fluid states
49
50#include <iostream>
51#include <string>
52#include <typeinfo>
53
58template <class ScalarT,
59 class FluidSystem,
62 : protected BaseFluidState
63{
64public:
65 enum { numPhases = FluidSystem::numPhases };
66 enum { numComponents = FluidSystem::numComponents };
67
68 typedef ScalarT Scalar;
69
71 {
72 // initially, do not allow anything
73 allowTemperature(false);
74 allowPressure(false);
75 allowComposition(false);
76 allowDensity(false);
77
78 // do not allow accessing any phase
79 restrictToPhase(1000);
80 }
81
82 void allowTemperature(bool yesno)
83 { allowTemperature_ = yesno; }
84
85 void allowPressure(bool yesno)
86 { allowPressure_ = yesno; }
87
88 void allowComposition(bool yesno)
89 { allowComposition_ = yesno; }
90
91 void allowDensity(bool yesno)
92 { allowDensity_ = yesno; }
93
94 void restrictToPhase(int phaseIdx)
95 { restrictPhaseIdx_ = phaseIdx; }
96
97 BaseFluidState& base()
98 { return *static_cast<BaseFluidState*>(this); }
99
100 const BaseFluidState& base() const
101 { return *static_cast<const BaseFluidState*>(this); }
102
103 auto temperature(unsigned phaseIdx) const
104 -> decltype(this->base().temperature(phaseIdx))
105 {
106 assert(allowTemperature_);
107 assert(restrictPhaseIdx_ < 0 || restrictPhaseIdx_ == static_cast<int>(phaseIdx));
108 return this->base().temperature(phaseIdx);
109 }
110
111 auto pressure(unsigned phaseIdx) const
112 -> decltype(this->base().pressure(phaseIdx))
113 {
114 assert(allowPressure_);
115 assert(restrictPhaseIdx_ < 0 || restrictPhaseIdx_ == static_cast<int>(phaseIdx));
116 return this->base().pressure(phaseIdx);
117 }
118
119 auto moleFraction(unsigned phaseIdx, unsigned compIdx) const
120 -> decltype(this->base().moleFraction(phaseIdx, compIdx))
121 {
122 assert(allowComposition_);
123 assert(restrictPhaseIdx_ < 0 || restrictPhaseIdx_ == static_cast<int>(phaseIdx));
124 return this->base().moleFraction(phaseIdx, compIdx);
125 }
126
127 auto massFraction(unsigned phaseIdx, unsigned compIdx) const
128 -> decltype(this->base().massFraction(phaseIdx, compIdx))
129 {
130 assert(allowComposition_);
131 assert(restrictPhaseIdx_ < 0 || restrictPhaseIdx_ == static_cast<int>(phaseIdx));
132 return this->base().massFraction(phaseIdx, compIdx);
133 }
134
135 auto averageMolarMass(unsigned phaseIdx) const
136 -> decltype(this->base().averageMolarMass(phaseIdx))
137 {
138 assert(allowComposition_);
139 assert(restrictPhaseIdx_ < 0 || restrictPhaseIdx_ == static_cast<int>(phaseIdx));
140 return this->base().averageMolarMass(phaseIdx);
141 }
142
143 auto molarity(unsigned phaseIdx, unsigned compIdx) const
144 -> decltype(this->base().molarity(phaseIdx, compIdx))
145 {
146 assert(allowDensity_ && allowComposition_);
147 assert(restrictPhaseIdx_ < 0 || restrictPhaseIdx_ == static_cast<int>(phaseIdx));
148 return this->base().molarity(phaseIdx, compIdx);
149 }
150
151 auto molarDensity(unsigned phaseIdx) const
152 -> decltype(this->base().molarDensity(phaseIdx))
153 {
154 assert(allowDensity_);
155 assert(restrictPhaseIdx_ < 0 || restrictPhaseIdx_ == static_cast<int>(phaseIdx));
156 return this->base().molarDensity(phaseIdx);
157 }
158
159 auto molarVolume(unsigned phaseIdx) const
160 -> decltype(this->base().molarVolume(phaseIdx))
161 {
162 assert(allowDensity_);
163 assert(restrictPhaseIdx_ < 0 || restrictPhaseIdx_ == static_cast<int>(phaseIdx));
164 return this->base().molarVolume(phaseIdx);
165 }
166
167 auto density(unsigned phaseIdx) const
168 -> decltype(this->base().density(phaseIdx))
169 {
170 assert(allowDensity_);
171 assert(restrictPhaseIdx_ < 0 || restrictPhaseIdx_ == static_cast<int>(phaseIdx));
172 return this->base().density(phaseIdx);
173 }
174
175 auto saturation(unsigned phaseIdx) const
176 -> decltype(this->base().saturation(phaseIdx))
177 {
178 assert(false);
179 return this->base().saturation(phaseIdx);
180 }
181
182 auto fugacity(unsigned phaseIdx, unsigned compIdx) const
183 -> decltype(this->base().fugacity(phaseIdx, compIdx))
184 {
185 assert(false);
186 return this->base().fugacity(phaseIdx, compIdx);
187 }
188
189 auto fugacityCoefficient(unsigned phaseIdx, unsigned compIdx) const
190 -> decltype(this->base().fugacityCoefficient(phaseIdx, compIdx))
191 {
192 assert(false);
193 return this->base().fugacityCoefficient(phaseIdx, compIdx);
194 }
195
196 auto enthalpy(unsigned phaseIdx) const
197 -> decltype(this->base().enthalpy(phaseIdx))
198 {
199 assert(false);
200 return this->base().enthalpy(phaseIdx);
201 }
202
203 auto internalEnergy(unsigned phaseIdx) const
204 -> decltype(this->base().internalEnergy(phaseIdx))
205 {
206 assert(false);
207 return this->base().internalEnergy(phaseIdx);
208 }
209
210 auto viscosity(unsigned phaseIdx) const
211 -> decltype(this->base().viscosity(phaseIdx))
212 {
213 assert(false);
214 return this->base().viscosity(phaseIdx);
215 }
216
217private:
218 bool allowSaturation_;
219 bool allowTemperature_;
220 bool allowPressure_;
221 bool allowComposition_;
222 bool allowDensity_;
223 int restrictPhaseIdx_;
224};
225
226template <class Scalar, class BaseFluidState>
227void checkFluidState(const BaseFluidState& fs)
228{
229 // fluid states must be copy-able
230 [[maybe_unused]] BaseFluidState tmpFs(fs);
231 tmpFs = fs;
232
233 // a fluid state must provide a checkDefined() method
234 fs.checkDefined();
235
236 // fluid states must export the types which they use as Scalars
237 typedef typename BaseFluidState::Scalar FsScalar;
238 static_assert(std::is_same<FsScalar, Scalar>::value,
239 "Fluid states must export the type they are given as scalar in an unmodified way");
240
241 // make sure the fluid state provides all mandatory methods
242 while (false) {
243 Scalar val = 1.0;
244
245 val = 2*val; // get rid of GCC warning (only occurs with paranoid warning flags)
246
247 val = fs.temperature(/*phaseIdx=*/0);
248 val = fs.pressure(/*phaseIdx=*/0);
249 val = fs.moleFraction(/*phaseIdx=*/0, /*compIdx=*/0);
250 val = fs.massFraction(/*phaseIdx=*/0, /*compIdx=*/0);
251 val = fs.averageMolarMass(/*phaseIdx=*/0);
252 val = fs.molarity(/*phaseIdx=*/0, /*compIdx=*/0);
253 val = fs.molarDensity(/*phaseIdx=*/0);
254 val = fs.molarVolume(/*phaseIdx=*/0);
255 val = fs.density(/*phaseIdx=*/0);
256 val = fs.saturation(/*phaseIdx=*/0);
257 val = fs.fugacity(/*phaseIdx=*/0, /*compIdx=*/0);
258 val = fs.fugacityCoefficient(/*phaseIdx=*/0, /*compIdx=*/0);
259 val = fs.enthalpy(/*phaseIdx=*/0);
260 val = fs.internalEnergy(/*phaseIdx=*/0);
261 val = fs.viscosity(/*phaseIdx=*/0);
262 };
263}
264
268template <class Scalar, class FluidSystem, class RhsEval, class LhsEval>
270{
271 std::cout << "Testing fluid system '" << Opm::demangle(typeid(FluidSystem).name()) << "'\n";
272
273 // make sure the fluid system provides the number of phases and
274 // the number of components
275 enum { numPhases = FluidSystem::numPhases };
276 enum { numComponents = FluidSystem::numComponents };
277
279 FluidState fs;
280 fs.allowTemperature(true);
281 fs.allowPressure(true);
282 fs.allowComposition(true);
283 fs.restrictToPhase(-1);
284
285 // initialize memory the fluid state
286 fs.base().setTemperature(273.15 + 20.0);
287 for (int phaseIdx = 0; phaseIdx < numPhases; ++ phaseIdx) {
288 fs.base().setPressure(phaseIdx, 1e5);
289 fs.base().setSaturation(phaseIdx, 1.0/numPhases);
290 for (int compIdx = 0; compIdx < numComponents; ++ compIdx) {
291 fs.base().setMoleFraction(phaseIdx, compIdx, 1.0/numComponents);
292 }
293 }
294
295 static_assert(std::is_same<typename FluidSystem::Scalar, Scalar>::value,
296 "The type used for floating point used by the fluid system must be the same"
297 " as the one passed to the checkFluidSystem() function");
298
299 // check whether the parameter cache adheres to the API
300 typedef typename FluidSystem::template ParameterCache<LhsEval> ParameterCache;
301
302 ParameterCache paramCache;
303 try { paramCache.updateAll(fs); } catch (...) {};
304 try { paramCache.updateAll(fs, /*except=*/ParameterCache::None); } catch (...) {};
305 try { paramCache.updateAll(fs, /*except=*/ParameterCache::Temperature | ParameterCache::Pressure | ParameterCache::Composition); } catch (...) {};
306 try { paramCache.updateAllPressures(fs); } catch (...) {};
307
308 for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
309 fs.restrictToPhase(static_cast<int>(phaseIdx));
310 try { paramCache.updatePhase(fs, phaseIdx); } catch (...) {};
311 try { paramCache.updatePhase(fs, phaseIdx, /*except=*/ParameterCache::None); } catch (...) {};
312 try { paramCache.updatePhase(fs, phaseIdx, /*except=*/ParameterCache::Temperature | ParameterCache::Pressure | ParameterCache::Composition); } catch (...) {};
313 try { paramCache.updateTemperature(fs, phaseIdx); } catch (...) {};
314 try { paramCache.updatePressure(fs, phaseIdx); } catch (...) {};
315 try { paramCache.updateComposition(fs, phaseIdx); } catch (...) {};
316 try { paramCache.updateSingleMoleFraction(fs, phaseIdx, /*compIdx=*/0); } catch (...) {};
317 }
318
319 // some value to make sure the return values of the fluid system
320 // are convertible to scalars
321 LhsEval val = 0.0;
322 Scalar scalarVal = 0.0;
323
324 scalarVal = 2*scalarVal; // get rid of GCC warning (only occurs with paranoid warning flags)
325 val = 2*val; // get rid of GCC warning (only occurs with paranoid warning flags)
326
327 // actually check the fluid system API
328 try { FluidSystem::init(); } catch (...) {};
329 for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++ phaseIdx) {
330 fs.restrictToPhase(static_cast<int>(phaseIdx));
331 fs.allowPressure(FluidSystem::isCompressible(phaseIdx));
332 fs.allowComposition(true);
333 fs.allowDensity(false);
334 try { [[maybe_unused]] auto tmpVal = FluidSystem::density(fs, paramCache, phaseIdx); static_assert(std::is_same<decltype(tmpVal), RhsEval>::value, "The default return value must be the scalar used by the fluid state!"); } catch (...) {};
335 try { val = FluidSystem::template density<FluidState, LhsEval>(fs, paramCache, phaseIdx); } catch (...) {};
336 try { scalarVal = FluidSystem::template density<FluidState, Scalar>(fs, paramCache, phaseIdx); } catch (...) {};
337
338 fs.allowPressure(true);
339 fs.allowDensity(true);
340 try { [[maybe_unused]] auto tmpVal = FluidSystem::viscosity(fs, paramCache, phaseIdx); static_assert(std::is_same<decltype(tmpVal), RhsEval>::value, "The default return value must be the scalar used by the fluid state!"); } catch (...) {};
341 try { [[maybe_unused]] auto tmpVal = FluidSystem::enthalpy(fs, paramCache, phaseIdx); static_assert(std::is_same<decltype(tmpVal), RhsEval>::value, "The default return value must be the scalar used by the fluid state!"); } catch (...) {};
342 try { [[maybe_unused]] auto tmpVal = FluidSystem::heatCapacity(fs, paramCache, phaseIdx); static_assert(std::is_same<decltype(tmpVal), RhsEval>::value, "The default return value must be the scalar used by the fluid state!"); } catch (...) {};
343 try { [[maybe_unused]] auto tmpVal = FluidSystem::thermalConductivity(fs, paramCache, phaseIdx); static_assert(std::is_same<decltype(tmpVal), RhsEval>::value, "The default return value must be the scalar used by the fluid state!"); } catch (...) {};
344 try { val = FluidSystem::template viscosity<FluidState, LhsEval>(fs, paramCache, phaseIdx); } catch (...) {};
345 try { val = FluidSystem::template enthalpy<FluidState, LhsEval>(fs, paramCache, phaseIdx); } catch (...) {};
346 try { val = FluidSystem::template heatCapacity<FluidState, LhsEval>(fs, paramCache, phaseIdx); } catch (...) {};
347 try { val = FluidSystem::template thermalConductivity<FluidState, LhsEval>(fs, paramCache, phaseIdx); } catch (...) {};
348 try { scalarVal = FluidSystem::template viscosity<FluidState, Scalar>(fs, paramCache, phaseIdx); } catch (...) {};
349 try { scalarVal = FluidSystem::template enthalpy<FluidState, Scalar>(fs, paramCache, phaseIdx); } catch (...) {};
350 try { scalarVal = FluidSystem::template heatCapacity<FluidState, Scalar>(fs, paramCache, phaseIdx); } catch (...) {};
351 try { scalarVal = FluidSystem::template thermalConductivity<FluidState, Scalar>(fs, paramCache, phaseIdx); } catch (...) {};
352
353 for (unsigned compIdx = 0; compIdx < numComponents; ++ compIdx) {
354 fs.allowComposition(!FluidSystem::isIdealMixture(phaseIdx));
355 try { [[maybe_unused]] auto tmpVal = FluidSystem::fugacityCoefficient(fs, paramCache, phaseIdx, compIdx); static_assert(std::is_same<decltype(tmpVal), RhsEval>::value, "The default return value must be the scalar used by the fluid state!"); } catch (...) {};
356 try { val = FluidSystem::template fugacityCoefficient<FluidState, LhsEval>(fs, paramCache, phaseIdx, compIdx); } catch (...) {};
357 try { scalarVal = FluidSystem::template fugacityCoefficient<FluidState, Scalar>(fs, paramCache, phaseIdx, compIdx); } catch (...) {};
358 fs.allowComposition(true);
359 try { [[maybe_unused]] auto tmpVal = FluidSystem::diffusionCoefficient(fs, paramCache, phaseIdx, compIdx); static_assert(std::is_same<decltype(tmpVal), RhsEval>::value, "The default return value must be the scalar used by the fluid state!"); } catch (...) {};
360 try { val = FluidSystem::template diffusionCoefficient<FluidState, LhsEval>(fs, paramCache, phaseIdx, compIdx); } catch (...) {};
361 try { scalarVal = FluidSystem::template fugacityCoefficient<FluidState, Scalar>(fs, paramCache, phaseIdx, compIdx); } catch (...) {};
362 }
363 }
364
365 // test for phaseName(), isLiquid() and isIdealGas()
366 for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++ phaseIdx) {
367 [[maybe_unused]] std::string name = FluidSystem::phaseName(phaseIdx);
368 bool bVal = FluidSystem::isLiquid(phaseIdx);
369 bVal = FluidSystem::isIdealGas(phaseIdx);
370 bVal = !bVal; // get rid of GCC warning (only occurs with paranoid warning flags)
371 }
372
373 // test for molarMass() and componentName()
374 for (unsigned compIdx = 0; compIdx < numComponents; ++ compIdx) {
375 val = FluidSystem::molarMass(compIdx);
376 std::string name = FluidSystem::componentName(compIdx);
377 }
378
379 std::cout << "----------------------------------\n";
380}
381
382#endif
Represents all relevant thermodynamic quantities of a multi-phase, multi-component fluid system assum...
Represents all relevant thermodynamic quantities of a multi-phase, multi-component fluid system assum...
Represents all relevant thermodynamic quantities of a multi-phase, multi-component fluid system not a...
void checkFluidSystem()
Checks whether a fluid system adheres to the specification.
Definition: checkFluidSystem.hpp:269
This is a fluid state which makes sure that only the quantities allowed are accessed.
Definition: checkFluidSystem.hpp:63
std::string demangle(const char *mangled_symbol)
Returns demangled name of symbol.