opm-simulators/opm/models/discretization/common/fvbaseconstraintscontext.hh
2019-09-19 10:28:26 +02:00

119 lines
3.2 KiB
C++

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*
This file is part of the Open Porous Media project (OPM).
OPM is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
OPM is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>.
Consult the COPYING file in the top-level source directory of this
module for the precise wording of the license and the list of
copyright holders.
*/
/*!
* \file
*
* \copydoc Opm::FvBaseConstraintsContext
*/
#ifndef EWOMS_FV_BASE_CONSTRAINTS_CONTEXT_HH
#define EWOMS_FV_BASE_CONSTRAINTS_CONTEXT_HH
#include "fvbaseproperties.hh"
#include <dune/common/fvector.hh>
namespace Opm {
/*!
* \ingroup FiniteVolumeDiscretizations
*
* \brief Represents all quantities which available for calculating constraints
*/
template<class TypeTag>
class FvBaseConstraintsContext
{
typedef typename GET_PROP_TYPE(TypeTag, Problem) Problem;
typedef typename GET_PROP_TYPE(TypeTag, Model) Model;
typedef typename GET_PROP_TYPE(TypeTag, ElementContext) ElementContext;
typedef typename GET_PROP_TYPE(TypeTag, GridView) GridView;
typedef typename GridView::template Codim<0>::Entity Element;
enum { dimWorld = GridView::dimensionworld };
typedef typename GridView::ctype CoordScalar;
typedef Dune::FieldVector<CoordScalar, dimWorld> GlobalPosition;
public:
/*!
* \brief The constructor.
*/
explicit FvBaseConstraintsContext(const ElementContext& elemCtx)
: elemCtx_(elemCtx)
{ }
/*!
* \copydoc Opm::ElementContext::problem()
*/
const Problem& problem() const
{ return elemCtx_.problem(); }
/*!
* \copydoc Opm::ElementContext::model()
*/
const Model& model() const
{ return elemCtx_.model(); }
/*!
* \copydoc Opm::ElementContext::gridView()
*/
const GridView& gridView() const
{ return elemCtx_.gridView(); }
/*!
* \copydoc Opm::ElementContext::element()
*/
const Element& element() const
{ return elemCtx_.element(); }
/*!
* \copydoc Opm::ElementContext::numDof()
*/
int numDof(int timeIdx) const
{ return elemCtx_.numDof(timeIdx); }
/*!
* \copydoc Opm::ElementContext::numInteriorFaces()
*/
int numInteriorFaces(int timeIdx) const
{ return elemCtx_.numInteriorFaces(timeIdx); }
/*!
* \copydoc Opm::ElementContext::globalSpaceIndex
*/
int globalSpaceIndex(int dofIdx, int timeIdx) const
{ return elemCtx_.globalSpaceIndex(dofIdx, timeIdx); }
/*!
* \copydoc Opm::ElementContext::pos
*/
GlobalPosition pos(int dofIdx, int timeIdx) const
{ return elemCtx_.pos(dofIdx, timeIdx); }
protected:
const ElementContext& elemCtx_;
};
} // namespace Opm
#endif