1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
// -*- 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 iterative linear solvers available in
* dune-istl.
*
* In conjunction with a suitable solver backend, solver wrappers work by specifying the
* "SolverWrapper" property:
* \code
* template<class TypeTag>
* struct LinearSolverWrapper<TypeTag, TTag::YourTypeTag>
* { using type = Opm::Linear::SolverWrapper$SOLVER<TypeTag>; };
* \endcode
*
* The possible choices for '\c $SOLVER' are:
* - \c Richardson: A fixpoint solver using the Richardson iteration
* - \c SteepestDescent: The steepest descent solver
* - \c ConjugatedGradients: A conjugated gradients solver
* - \c BiCGStab: A stabilized bi-conjugated gradients solver
* - \c MinRes: A solver based on the minimized residual algorithm
* - \c RestartedGMRes: A restarted GMRES solver
*/
#ifndef EWOMS_ISTL_SOLVER_WRAPPERS_HH
#define EWOMS_ISTL_SOLVER_WRAPPERS_HH
#include <opm/models/utils/propertysystem.hh>
#include <opm/models/utils/parametersystem.hh>
#include <opm/simulators/linalg/linalgproperties.hh>
#include <dune/istl/solvers.hh>
namespace Opm::Linear {
/*!
* \brief Macro to create a wrapper around an ISTL solver
*/
#define EWOMS_WRAP_ISTL_SOLVER(SOLVER_NAME, ISTL_SOLVER_NAME) \
template <class TypeTag> \
class SolverWrapper##SOLVER_NAME \
{ \
using Scalar = GetPropType<TypeTag, Properties::Scalar>; \
using OverlappingMatrix = GetPropType<TypeTag, Properties::OverlappingMatrix>; \
using OverlappingVector = GetPropType<TypeTag, Properties::OverlappingVector>; \
\
public: \
using RawSolver = ISTL_SOLVER_NAME<OverlappingVector>; \
\
SolverWrapper##SOLVER_NAME() \
{} \
\
static void registerParameters() \
{} \
\
template <class LinearOperator, class ScalarProduct, class Preconditioner> \
std::shared_ptr<RawSolver> get(LinearOperator& parOperator, \
ScalarProduct& parScalarProduct, \
Preconditioner& parPreCond) \
{ \
Scalar tolerance = EWOMS_GET_PARAM(TypeTag, Scalar, \
LinearSolverTolerance); \
int maxIter = EWOMS_GET_PARAM(TypeTag, int, LinearSolverMaxIterations);\
\
int verbosity = 0; \
if (parOperator.overlap().myRank() == 0) \
verbosity = EWOMS_GET_PARAM(TypeTag, int, LinearSolverVerbosity); \
solver_ = std::make_shared<RawSolver>(parOperator, parScalarProduct, \
parPreCond, tolerance, maxIter, \
verbosity); \
\
return solver_; \
} \
\
void cleanup() \
{ solver_.reset(); } \
\
private: \
std::shared_ptr<RawSolver> solver_; \
};
EWOMS_WRAP_ISTL_SOLVER(Richardson, Dune::LoopSolver)
EWOMS_WRAP_ISTL_SOLVER(SteepestDescent, Dune::GradientSolver)
EWOMS_WRAP_ISTL_SOLVER(ConjugatedGradients, Dune::CGSolver)
EWOMS_WRAP_ISTL_SOLVER(BiCGStab, Dune::BiCGSTABSolver)
EWOMS_WRAP_ISTL_SOLVER(MinRes, Dune::MINRESSolver)
/*!
* \brief Solver wrapper for the restarted GMRES solver of dune-istl.
*
* dune-istl uses a slightly different API for this solver than for the others...
*/
template <class TypeTag>
class SolverWrapperRestartedGMRes
{
using Scalar = GetPropType<TypeTag, Properties::Scalar>;
using OverlappingMatrix = GetPropType<TypeTag, Properties::OverlappingMatrix>;
using OverlappingVector = GetPropType<TypeTag, Properties::OverlappingVector>;
public:
using RawSolver = Dune::RestartedGMResSolver<OverlappingVector>;
SolverWrapperRestartedGMRes()
{}
static void registerParameters()
{
EWOMS_REGISTER_PARAM(TypeTag, int, GMResRestart,
"Number of iterations after which the GMRES linear solver is restarted");
}
template <class LinearOperator, class ScalarProduct, class Preconditioner>
std::shared_ptr<RawSolver> get(LinearOperator& parOperator,
ScalarProduct& parScalarProduct,
Preconditioner& parPreCond)
{
Scalar tolerance = EWOMS_GET_PARAM(TypeTag, Scalar, LinearSolverTolerance);
int maxIter = EWOMS_GET_PARAM(TypeTag, int, LinearSolverMaxIterations);
int verbosity = 0;
if (parOperator.overlap().myRank() == 0)
verbosity = EWOMS_GET_PARAM(TypeTag, int, LinearSolverVerbosity);
int restartAfter = EWOMS_GET_PARAM(TypeTag, int, GMResRestart);
solver_ = std::make_shared<RawSolver>(parOperator,
parScalarProduct,
parPreCond,
tolerance,
restartAfter,
maxIter,
verbosity);
return solver_;
}
void cleanup()
{ solver_.reset(); }
private:
std::shared_ptr<RawSolver> solver_;
};
#undef EWOMS_WRAP_ISTL_SOLVER
} // namespace Opm::Linear
#endif
|
