Files
opm-simulators/applications/ebos/ecldummygradientcalculator.hh
Andreas Lauser e769c2768c clean up the licensing preable of source files
the in-file lists of authors has been removed in favor of a global
list of authors in the LICENSE file. this is done because (a)
maintaining a list of authors at the beginning of a file is a major
pain in the a**, (b) the list of authors was not accurate in about 85%
of all cases where more than one person was involved and (c) this list
is not legally binding in any way (the copyright is at the person who
authored a given change, if these lists had any legal relevance, one
could "aquire" the copyright of the module by forking it and removing
the lists...)

the only exception of this is the eWoms fork of dune-istl's solvers.hh
file. This is beneficial because the authors of that file do not
appear in the global list. Further, carrying the fork of that file is
required because we would like to use a reasonable convergence
criterion for the linear solver. (the solvers from dune-istl do
neither support user-defined convergence criteria not do the
developers want support for it. (my patch was rejected a few years
ago.))
2016-03-17 13:20:20 +01:00

107 lines
3.7 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 Ewoms::EclDummyGradientCalculator
*/
#ifndef EWOMS_ECL_DUMMY_GRADIENT_CALCULATOR_HH
#define EWOMS_ECL_DUMMY_GRADIENT_CALCULATOR_HH
#include <ewoms/disc/common/fvbaseproperties.hh>
#include <dune/common/fvector.hh>
namespace Ewoms {
/*!
* \ingroup EclBlackOilSimulator
*
* \brief This is a "dummy" gradient calculator which does not do anything.
*
* The ECL blackoil simulator does not need any gradients: Volume fluxes are calculated
* via pressure differences instead of pressure gradients (i.e., transmissibilities
* instead of permeabilities), and an energy equation and molecular diffusion are not
* supported.
*/
template<class TypeTag>
class EclDummyGradientCalculator
{
typedef typename GET_PROP_TYPE(TypeTag, GridView) GridView;
typedef typename GET_PROP_TYPE(TypeTag, Scalar) Scalar;
typedef typename GET_PROP_TYPE(TypeTag, ElementContext) ElementContext;
enum { dimWorld = GridView::dimensionworld };
typedef Dune::FieldVector<Scalar, dimWorld> DimVector;
public:
static void registerParameters()
{ }
template <bool prepareValues = true, bool prepareGradients = true>
void prepare(const ElementContext &elemCtx, unsigned timeIdx)
{ }
template <class QuantityCallback, class QuantityType = Scalar>
QuantityType calculateValue(const ElementContext &elemCtx,
unsigned fapIdx,
const QuantityCallback &quantityCallback) const
{
OPM_THROW(std::logic_error,
"Generic values are not supported by the ECL black-oil simulator");
}
template <class QuantityCallback>
void calculateGradient(DimVector &quantityGrad,
const ElementContext &elemCtx,
unsigned fapIdx,
const QuantityCallback &quantityCallback) const
{
OPM_THROW(std::logic_error,
"Generic gradients are not supported by the ECL black-oil simulator");
}
template <class QuantityCallback>
Scalar calculateBoundaryValue(const ElementContext &elemCtx,
unsigned fapIdx,
const QuantityCallback &quantityCallback)
{
OPM_THROW(std::logic_error,
"Generic boundary values are not supported by the ECL black-oil simulator");
}
template <class QuantityCallback>
void calculateBoundaryGradient(DimVector &quantityGrad,
const ElementContext &elemCtx,
unsigned fapIdx,
const QuantityCallback &quantityCallback) const
{
OPM_THROW(std::logic_error,
"Generic boundary gradients are not supported by the ECL black-oil simulator");
}
};
} // namespace Ewoms
#endif