/
kinsolsolverplugin.cpp
219 lines (158 loc) · 7.91 KB
/
kinsolsolverplugin.cpp
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
/*******************************************************************************
Copyright (C) The University of Auckland
OpenCOR 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 3 of the License, or
(at your option) any later version.
OpenCOR 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 this program. If not, see <https://gnu.org/licenses>.
*******************************************************************************/
//==============================================================================
// KINSOL solver plugin
//==============================================================================
#include "kinsolsolver.h"
#include "kinsolsolverplugin.h"
//==============================================================================
namespace OpenCOR {
namespace KINSOLSolver {
//==============================================================================
PLUGININFO_FUNC KINSOLSolverPluginInfo()
{
Descriptions descriptions;
descriptions.insert("en", QString::fromUtf8(R"(a plugin that uses <a href="https://computation.llnl.gov/projects/sundials/kinsol">KINSOL</a> to solve <a href="https://en.wikipedia.org/wiki/Nonlinear_system#Nonlinear_algebraic_equations">non-linear algebraic systems</a>.)"));
descriptions.insert("fr", QString::fromUtf8(R"(une extension qui utilise <a href="https://computation.llnl.gov/projects/sundials/kinsol">KINSOL</a> pour résoudre des <a href="https://en.wikipedia.org/wiki/Nonlinear_system#Nonlinear_algebraic_equations">systèmes algébriques non-linéaires</a>.)"));
return new PluginInfo(PluginInfo::Category::Solver, true, false,
{ "SUNDIALS" },
descriptions);
}
//==============================================================================
// I18n interface
//==============================================================================
void KINSOLSolverPlugin::retranslateUi()
{
// We don't handle this interface...
// Note: even though we don't handle this interface, we still want to
// support it since some other aspects of our plugin are
// multilingual...
}
//==============================================================================
// Solver interface
//==============================================================================
Solver::Solver * KINSOLSolverPlugin::solverInstance() const
{
// Create and return an instance of the solver
return new KinsolSolver();
}
//==============================================================================
QString KINSOLSolverPlugin::id(const QString &pKisaoId) const
{
// Return the id for the given KiSAO id
static const QString Kisao0000282 = "KISAO:0000282";
static const QString Kisao0000486 = "KISAO:0000486";
static const QString Kisao0000477 = "KISAO:0000477";
static const QString Kisao0000479 = "KISAO:0000479";
static const QString Kisao0000480 = "KISAO:0000480";
if (pKisaoId == Kisao0000282) {
return solverName();
}
if (pKisaoId == Kisao0000486) {
return MaximumNumberOfIterationsId;
}
if (pKisaoId == Kisao0000477) {
return LinearSolverId;
}
if (pKisaoId == Kisao0000479) {
return UpperHalfBandwidthId;
}
if (pKisaoId == Kisao0000480) {
return LowerHalfBandwidthId;
}
return {};
}
//==============================================================================
QString KINSOLSolverPlugin::kisaoId(const QString &pId) const
{
// Return the KiSAO id for the given id
if (pId == solverName()) {
return "KISAO:0000282";
}
if (pId == MaximumNumberOfIterationsId) {
return "KISAO:0000486";
}
if (pId == LinearSolverId) {
return "KISAO:0000477";
}
if (pId == UpperHalfBandwidthId) {
return "KISAO:0000479";
}
if (pId == LowerHalfBandwidthId) {
return "KISAO:0000480";
}
return {};
}
//==============================================================================
Solver::Type KINSOLSolverPlugin::solverType() const
{
// Return the type of the solver
return Solver::Type::Nla;
}
//==============================================================================
QString KINSOLSolverPlugin::solverName() const
{
// Return the name of the solver
return "KINSOL";
}
//==============================================================================
Solver::Properties KINSOLSolverPlugin::solverProperties() const
{
// Return the properties supported by the solver
Descriptions MaximumNumberOfIterationsDescriptions;
Descriptions LinearSolverDescriptions;
Descriptions UpperHalfBandwidthDescriptions;
Descriptions LowerHalfBandwidthDescriptions;
MaximumNumberOfIterationsDescriptions.insert("en", QString::fromUtf8("Maximum number of iterations"));
MaximumNumberOfIterationsDescriptions.insert("fr", QString::fromUtf8("Nombre maximum d'itérations"));
LinearSolverDescriptions.insert("en", QString::fromUtf8("Linear solver"));
LinearSolverDescriptions.insert("fr", QString::fromUtf8("Solveur linéaire"));
UpperHalfBandwidthDescriptions.insert("en", QString::fromUtf8("Upper half-bandwidth"));
UpperHalfBandwidthDescriptions.insert("fr", QString::fromUtf8("Demi largeur de bande supérieure"));
LowerHalfBandwidthDescriptions.insert("en", QString::fromUtf8("Lower half-bandwidth"));
LowerHalfBandwidthDescriptions.insert("fr", QString::fromUtf8("Demi largeur de bande inférieure"));
QStringList LinearSolverListValues = { DenseLinearSolver,
BandedLinearSolver,
GmresLinearSolver,
BiCgStabLinearSolver,
TfqmrLinearSolver };
return Solver::Properties() << Solver::Property(Solver::Property::Type::IntegerGt0, MaximumNumberOfIterationsId, MaximumNumberOfIterationsDescriptions, QStringList(), MaximumNumberOfIterationsDefaultValue, false)
<< Solver::Property(Solver::Property::Type::List, LinearSolverId, LinearSolverDescriptions, LinearSolverListValues, LinearSolverDefaultValue, false)
<< Solver::Property(Solver::Property::Type::IntegerGe0, UpperHalfBandwidthId, UpperHalfBandwidthDescriptions, QStringList(), UpperHalfBandwidthDefaultValue, false)
<< Solver::Property(Solver::Property::Type::IntegerGe0, LowerHalfBandwidthId, LowerHalfBandwidthDescriptions, QStringList(), LowerHalfBandwidthDefaultValue, false);
}
//==============================================================================
QMap<QString, bool> KINSOLSolverPlugin::solverPropertiesVisibility(const QMap<QString, QString> &pSolverPropertiesValues) const
{
// Return the visibility of our properties based on the given properties
// values
QMap<QString, bool> res;
QString linearSolver = pSolverPropertiesValues.value(LinearSolverId);
if (linearSolver == BandedLinearSolver) {
// Banded linear solver
res.insert(UpperHalfBandwidthId, true);
res.insert(LowerHalfBandwidthId, true);
} else {
// Dense/GMRES/Bi-CGStab/TFQMR linear solver
res.insert(UpperHalfBandwidthId, false);
res.insert(LowerHalfBandwidthId, false);
}
return res;
}
//==============================================================================
} // namespace KINSOLSolver
} // namespace OpenCOR
//==============================================================================
// End of file
//==============================================================================