mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-02-20 11:48:25 -06:00
7fb622bba6
The function name is now CamelCase and the old naming scheme is deprecated. Hence we use the new naming for 2.8 There was also a compilation problem due to header inclusion order for that function. The compiler did not find our version the correct version. With this change compilation succeeds again.
200 lines
10 KiB
C++
200 lines
10 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
|
|
* \brief Provides wrapper classes for the (non-AMG) preconditioners provided by
|
|
* dune-istl.
|
|
*
|
|
* In conjunction with a suitable solver backend, preconditioner wrappers work by
|
|
* specifying the "PreconditionerWrapper" property:
|
|
* \code
|
|
* template<class TypeTag>
|
|
* struct PreconditionerWrapper<TypeTag, TTag::YourTypeTag>
|
|
* { using type = Opm::Linear::PreconditionerWrapper$PRECONDITIONER<TypeTag>; };
|
|
* \endcode
|
|
*
|
|
* Where the choices possible for '\c $PRECONDITIONER' are:
|
|
* - \c Jacobi: A Jacobi preconditioner
|
|
* - \c GaussSeidel: A Gauss-Seidel preconditioner
|
|
* - \c SSOR: A symmetric successive overrelaxation (SSOR) preconditioner
|
|
* - \c SOR: A successive overrelaxation (SOR) preconditioner
|
|
* - \c ILUn: An ILU(n) preconditioner
|
|
* - \c ILU0: A specialized (and optimized) ILU(0) preconditioner
|
|
*/
|
|
#ifndef EWOMS_ISTL_PRECONDITIONER_WRAPPERS_HH
|
|
#define EWOMS_ISTL_PRECONDITIONER_WRAPPERS_HH
|
|
|
|
#include <opm/models/utils/propertysystem.hh>
|
|
#include <opm/models/utils/parametersystem.hh>
|
|
#include <opm/simulators/linalg/linalgproperties.hh>
|
|
#include <opm/simulators/linalg/ilufirstelement.hh> //definitions needed in next header
|
|
#include <dune/istl/preconditioners.hh>
|
|
|
|
#include <dune/common/version.hh>
|
|
|
|
namespace Opm {
|
|
namespace Linear {
|
|
#define EWOMS_WRAP_ISTL_PRECONDITIONER(PREC_NAME, ISTL_PREC_TYPE) \
|
|
template <class TypeTag> \
|
|
class PreconditionerWrapper##PREC_NAME \
|
|
{ \
|
|
using Scalar = GetPropType<TypeTag, Properties::Scalar>; \
|
|
using SparseMatrixAdapter = GetPropType<TypeTag, Properties::SparseMatrixAdapter>; \
|
|
using IstlMatrix = typename SparseMatrixAdapter::IstlMatrix; \
|
|
using OverlappingVector = GetPropType<TypeTag, Properties::OverlappingVector>; \
|
|
\
|
|
public: \
|
|
using SequentialPreconditioner = ISTL_PREC_TYPE<IstlMatrix, \
|
|
OverlappingVector, \
|
|
OverlappingVector>; \
|
|
PreconditionerWrapper##PREC_NAME() \
|
|
{} \
|
|
\
|
|
static void registerParameters() \
|
|
{ \
|
|
EWOMS_REGISTER_PARAM(TypeTag, int, PreconditionerOrder, \
|
|
"The order of the preconditioner"); \
|
|
EWOMS_REGISTER_PARAM(TypeTag, Scalar, PreconditionerRelaxation, \
|
|
"The relaxation factor of the " \
|
|
"preconditioner"); \
|
|
} \
|
|
\
|
|
void prepare(IstlMatrix& matrix) \
|
|
{ \
|
|
int order = EWOMS_GET_PARAM(TypeTag, int, PreconditionerOrder); \
|
|
Scalar relaxationFactor = EWOMS_GET_PARAM(TypeTag, Scalar, PreconditionerRelaxation); \
|
|
seqPreCond_ = new SequentialPreconditioner(matrix, order, \
|
|
relaxationFactor); \
|
|
} \
|
|
\
|
|
SequentialPreconditioner& get() \
|
|
{ return *seqPreCond_; } \
|
|
\
|
|
void cleanup() \
|
|
{ delete seqPreCond_; } \
|
|
\
|
|
private: \
|
|
SequentialPreconditioner *seqPreCond_; \
|
|
};
|
|
|
|
// the same as the EWOMS_WRAP_ISTL_PRECONDITIONER macro, but without
|
|
// an 'order' argument for the preconditioner's constructor
|
|
#define EWOMS_WRAP_ISTL_SIMPLE_PRECONDITIONER(PREC_NAME, ISTL_PREC_TYPE) \
|
|
template <class TypeTag> \
|
|
class PreconditionerWrapper##PREC_NAME \
|
|
{ \
|
|
using Scalar = GetPropType<TypeTag, Properties::Scalar>; \
|
|
using OverlappingMatrix = GetPropType<TypeTag, Properties::OverlappingMatrix>; \
|
|
using OverlappingVector = GetPropType<TypeTag, Properties::OverlappingVector>; \
|
|
\
|
|
public: \
|
|
using SequentialPreconditioner = ISTL_PREC_TYPE<OverlappingMatrix, \
|
|
OverlappingVector, \
|
|
OverlappingVector>; \
|
|
PreconditionerWrapper##PREC_NAME() \
|
|
{} \
|
|
\
|
|
static void registerParameters() \
|
|
{ \
|
|
EWOMS_REGISTER_PARAM(TypeTag, Scalar, PreconditionerRelaxation, \
|
|
"The relaxation factor of the " \
|
|
"preconditioner"); \
|
|
} \
|
|
\
|
|
void prepare(OverlappingMatrix& matrix) \
|
|
{ \
|
|
Scalar relaxationFactor = \
|
|
EWOMS_GET_PARAM(TypeTag, Scalar, PreconditionerRelaxation); \
|
|
seqPreCond_ = new SequentialPreconditioner(matrix, \
|
|
relaxationFactor); \
|
|
} \
|
|
\
|
|
SequentialPreconditioner& get() \
|
|
{ return *seqPreCond_; } \
|
|
\
|
|
void cleanup() \
|
|
{ delete seqPreCond_; } \
|
|
\
|
|
private: \
|
|
SequentialPreconditioner *seqPreCond_; \
|
|
};
|
|
|
|
EWOMS_WRAP_ISTL_PRECONDITIONER(Jacobi, Dune::SeqJac)
|
|
// EWOMS_WRAP_ISTL_PRECONDITIONER(Richardson, Dune::Richardson)
|
|
EWOMS_WRAP_ISTL_PRECONDITIONER(GaussSeidel, Dune::SeqGS)
|
|
EWOMS_WRAP_ISTL_PRECONDITIONER(SOR, Dune::SeqSOR)
|
|
EWOMS_WRAP_ISTL_PRECONDITIONER(SSOR, Dune::SeqSSOR)
|
|
|
|
#if DUNE_VERSION_NEWER(DUNE_ISTL, 2,7)
|
|
|
|
// we need a custom preconditioner wrapper for ILU because the Dune::SeqILU class uses a
|
|
// non-standard extra template parameter to specify its order.
|
|
template <class TypeTag>
|
|
class PreconditionerWrapperILU
|
|
{
|
|
using Scalar = GetPropType<TypeTag, Properties::Scalar>;
|
|
using OverlappingMatrix = GetPropType<TypeTag, Properties::OverlappingMatrix>;
|
|
using OverlappingVector = GetPropType<TypeTag, Properties::OverlappingVector>;
|
|
|
|
static constexpr int order = getPropValue<TypeTag, Properties::PreconditionerOrder>();
|
|
|
|
public:
|
|
using SequentialPreconditioner = Dune::SeqILU<OverlappingMatrix, OverlappingVector, OverlappingVector, order>;
|
|
|
|
PreconditionerWrapperILU()
|
|
{}
|
|
|
|
static void registerParameters()
|
|
{
|
|
EWOMS_REGISTER_PARAM(TypeTag, Scalar, PreconditionerRelaxation,
|
|
"The relaxation factor of the preconditioner");
|
|
}
|
|
|
|
void prepare(OverlappingMatrix& matrix)
|
|
{
|
|
Scalar relaxationFactor = EWOMS_GET_PARAM(TypeTag, Scalar, PreconditionerRelaxation);
|
|
|
|
// create the sequential preconditioner.
|
|
seqPreCond_ = new SequentialPreconditioner(matrix, relaxationFactor);
|
|
}
|
|
|
|
SequentialPreconditioner& get()
|
|
{ return *seqPreCond_; }
|
|
|
|
void cleanup()
|
|
{ delete seqPreCond_; }
|
|
|
|
private:
|
|
SequentialPreconditioner *seqPreCond_;
|
|
};
|
|
|
|
#else
|
|
EWOMS_WRAP_ISTL_SIMPLE_PRECONDITIONER(ILU0, Dune::SeqILU0)
|
|
EWOMS_WRAP_ISTL_PRECONDITIONER(ILUn, Dune::SeqILUn)
|
|
#endif
|
|
|
|
#undef EWOMS_WRAP_ISTL_PRECONDITIONER
|
|
}} // namespace Linear, Opm
|
|
|
|
#endif
|