pvsratevector.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  Copyright (C) 2011-2013 by Andreas Lauser
5 
6  This file is part of the Open Porous Media project (OPM).
7 
8  OPM is free software: you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation, either version 2 of the License, or
11  (at your option) any later version.
12 
13  OPM is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU General Public License for more details.
17 
18  You should have received a copy of the GNU General Public License
19  along with OPM. If not, see <http://www.gnu.org/licenses/>.
20 */
26 #ifndef EWOMS_PVS_RATE_VECTOR_HH
27 #define EWOMS_PVS_RATE_VECTOR_HH
28 
29 #include "pvsindices.hh"
30 
32 #include <opm/material/constraintsolvers/NcpFlash.hpp>
33 #include <opm/material/common/Valgrind.hpp>
34 
35 #include <dune/common/fvector.hh>
36 
37 namespace Ewoms {
38 
47 template <class TypeTag>
49  : public Dune::FieldVector<typename GET_PROP_TYPE(TypeTag, Evaluation),
50  GET_PROP_VALUE(TypeTag, NumEq)>
51 {
52  typedef typename GET_PROP_TYPE(TypeTag, Scalar) Scalar;
53  typedef typename GET_PROP_TYPE(TypeTag, Evaluation) Evaluation;
54  typedef typename GET_PROP_TYPE(TypeTag, FluidSystem) FluidSystem;
55  typedef typename GET_PROP_TYPE(TypeTag, Indices) Indices;
56 
57  enum { conti0EqIdx = Indices::conti0EqIdx };
58  enum { numComponents = GET_PROP_VALUE(TypeTag, NumComponents) };
59  enum { numEq = GET_PROP_VALUE(TypeTag, NumEq) };
60  enum { enableEnergy = GET_PROP_VALUE(TypeTag, EnableEnergy) };
61 
62  typedef Dune::FieldVector<Evaluation, numEq> ParentType;
64 
65 public:
66  PvsRateVector() : ParentType()
67  { Valgrind::SetUndefined(*this); }
68 
72  PvsRateVector(const Evaluation& value)
73  : ParentType(value)
74  {}
75 
79  PvsRateVector(const PvsRateVector &value) : ParentType(value)
80  {}
81 
85  void setMassRate(const ParentType &value)
86  {
87  // convert to molar rates
88  for (int compIdx = 0; compIdx < numComponents; ++compIdx) {
89  (*this)[compIdx] = value[compIdx];
90  (*this)[compIdx] /= FluidSystem::molarMass(compIdx);
91  }
92  }
93 
97  void setMolarRate(const ParentType &value)
98  { ParentType::operator=(value); }
99 
103  template <class RhsEval>
104  void setEnthalpyRate(const RhsEval& rate)
105  { EnergyModule::setEnthalpyRate(*this, rate); }
106 
110  template <class FluidState, class RhsEval>
111  void setVolumetricRate(const FluidState &fluidState, int phaseIdx, const RhsEval& volume)
112  {
113  for (int compIdx = 0; compIdx < numComponents; ++compIdx)
114  (*this)[conti0EqIdx + compIdx] =
115  fluidState.density(phaseIdx, compIdx)
116  * fluidState.moleFraction(phaseIdx, compIdx)
117  * volume;
118 
119  EnergyModule::setEnthalpyRate(*this, fluidState, phaseIdx, volume);
120  }
121 
125  template <class RhsEval>
126  PvsRateVector& operator=(const RhsEval& value)
127  {
128  for (unsigned i=0; i < this->size(); ++i)
129  (*this)[i] = value;
130  return *this;
131  }
132 
137  {
138  for (unsigned i=0; i < this->size(); ++i)
139  (*this)[i] = other[i];
140  return *this;
141  }
142 };
143 
144 } // namespace Ewoms
145 
146 #endif
Implements a vector representing molar, mass or volumetric rates.
Definition: pvsratevector.hh:48
#define GET_PROP_VALUE(TypeTag, PropTagName)
Access the value attribute of a property for a type tag.
Definition: propertysystem.hh:468
The indices for the compositional multi-phase primary variable switching model.
void setEnthalpyRate(const RhsEval &rate)
Set an enthalpy rate [J/As] where .
Definition: pvsratevector.hh:104
PvsRateVector(const PvsRateVector &value)
Copy constructor.
Definition: pvsratevector.hh:79
void setMassRate(const ParentType &value)
Set a mass rate of the conservation quantities.
Definition: pvsratevector.hh:85
void setMolarRate(const ParentType &value)
Set a molar rate of the conservation quantities.
Definition: pvsratevector.hh:97
Provides the auxiliary methods required for consideration of the energy equation. ...
Definition: energymodule.hh:54
Definition: baseauxiliarymodule.hh:35
PvsRateVector & operator=(const RhsEval &value)
Assignment operator from a scalar or a function evaluation.
Definition: pvsratevector.hh:126
void setVolumetricRate(const FluidState &fluidState, int phaseIdx, const RhsEval &volume)
Set a volumetric rate of a phase.
Definition: pvsratevector.hh:111
PvsRateVector & operator=(const PvsRateVector &other)
Assignment operator from another rate vector.
Definition: pvsratevector.hh:136
PvsRateVector()
Definition: pvsratevector.hh:66
Contains the classes required to consider energy as a conservation quantity in a multi-phase module...
PvsRateVector(const Evaluation &value)
Definition: pvsratevector.hh:72