baseauxiliarymodule.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 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 EWOMS_BASE_AUXILIARY_MODULE_HH
28#define EWOMS_BASE_AUXILIARY_MODULE_HH
29
31
34
35#include <set>
36#include <vector>
37
39
40struct AuxModule {};
41
42} // namespace Opm::Properties::TTag
43
44namespace Opm {
45
54template <class TypeTag>
56{
61
62protected:
63 using NeighborSet = std::set<unsigned>;
64
65public:
67 {}
68
73 virtual unsigned numDofs() const = 0;
74
79 void setDofOffset(int value)
80 { dofOffset_ = value; }
81
87 { return dofOffset_; }
88
93 int localToGlobalDof(unsigned localDofIdx) const
94 {
95 assert(localDofIdx < numDofs());
96 return dofOffset_ + localDofIdx;
97 }
98
103 virtual void addNeighbors(std::vector<NeighborSet>& neighbors) const = 0;
104
108 virtual void applyInitial() = 0;
109
113 virtual void linearize(SparseMatrixAdapter& matrix, GlobalEqVector& residual) = 0;
114
121 virtual void postSolve(GlobalEqVector&)
122 {};
123
124private:
125 int dofOffset_;
126};
127
128} // namespace Opm
129
130#endif
Base class for specifying auxiliary equations.
Definition: baseauxiliarymodule.hh:56
int dofOffset()
Return the offset in the global system of equations for the first degree of freedom of this auxiliary...
Definition: baseauxiliarymodule.hh:86
virtual void linearize(SparseMatrixAdapter &matrix, GlobalEqVector &residual)=0
Linearize the auxiliary equation.
std::set< unsigned > NeighborSet
Definition: baseauxiliarymodule.hh:63
virtual ~BaseAuxiliaryModule()
Definition: baseauxiliarymodule.hh:66
virtual void applyInitial()=0
Set the initial condition of the auxiliary module in the solution vector.
virtual void addNeighbors(std::vector< NeighborSet > &neighbors) const =0
Specify the additional neighboring correlations caused by the auxiliary module.
virtual unsigned numDofs() const =0
Returns the number of additional degrees of freedom required for the auxiliary module.
virtual void postSolve(GlobalEqVector &)
This method is called after the linear solver has been called but before the solution is updated for ...
Definition: baseauxiliarymodule.hh:121
void setDofOffset(int value)
Set the offset in the global system of equations for the first degree of freedom of this auxiliary mo...
Definition: baseauxiliarymodule.hh:79
int localToGlobalDof(unsigned localDofIdx) const
Given a degree of freedom relative to the current auxiliary equation, return the corresponding index ...
Definition: baseauxiliarymodule.hh:93
Declare the properties used by the infrastructure code of the finite volume discretizations.
Declares the properties required by the black oil model.
Definition: baseauxiliarymodule.hh:38
Definition: blackoilboundaryratevector.hh:37
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:235
The Opm property system, traits with inheritance.
Definition: baseauxiliarymodule.hh:40