OEMSolver.h 8.25 KB
Newer Older
1
2
3
4
5
6
// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
7
// ==  TU Dresden                                                            ==
8
// ==                                                                        ==
9
10
11
// ==  Institut fr Wissenschaftliches Rechnen                               ==
// ==  Zellescher Weg 12-14                                                  ==
// ==  01069 Dresden                                                         ==
12
13
14
15
// ==  germany                                                               ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
16
// ==  https://gforge.zih.tu-dresden.de/projects/amdis/                      ==
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
// ==                                                                        ==
// ============================================================================

/** \file OEMSolver.h */

/**
 * \defgroup Solver Solver module
 * @{ <img src="solver.png"> @}
 * 
 * \brief
 * Contains all classes needed for solving linear and non linear equation
 * systems.
 */

#ifndef AMDIS_OEM_SOLVER_H
#define AMDIS_OEM_SOLVER_H

#include "Global.h"
35
36
37
38
39
40
41
#include "AMDiS_fwd.h"
#include "Parameters.h"
#include "SolverMatrix.h"
#include "DOFVector.h"
#include "SystemVector.h"
#include "DOFMatrix.h"
#include "ITL_Preconditioner.h"
42
43
44
45
46
47
48
49
50
51
52
53

namespace AMDiS {

  /**
   * \ingroup Solver
   * 
   *\brief
   * Solver for linear equation systems.
   */
  class OEMSolver
  {
  public:
54
55
56
57

    typedef DOFMatrix::base_matrix_type   matrix_type;
    typedef DOFMatrix::value_type         value_type;

58
    /// The constructor reads needed parameters and sets solvers \ref name.
59
60
61
62
63
64
65
66
    OEMSolver(std::string str) 
      : name(str),
	tolerance(0),
	relative(0),
	max_iter(1000),
	info(0),
	residual(0),
	print_cycle(100),
67
68
	iterations(-1),
	error(-1),
69
70
71
	leftPrecon(NULL),
	rightPrecon(NULL)
    {}
72

73
    ///
74
    virtual ~OEMSolver() 
75
    {
76
77
78
      if (leftPrecon) delete leftPrecon;
      if (rightPrecon) delete rightPrecon;
    }
79

80
81
82
    void initParameters()
    {
      FUNCNAME("OEMSolver::initParameters()");
83
      
84
85
86
87
88
89
      GET_PARAMETER(0, name + "->tolerance", "%f", &tolerance);
      GET_PARAMETER(0, name + "->relative tolerance", "%f", &relative);
      GET_PARAMETER(0, name + "->max iteration", "%d", &max_iter);
      GET_PARAMETER(0, name + "->print cycle", "%d", &print_cycle);
      GET_PARAMETER(0, name + "->info", "%d", &info);
    }
90

91
92
93
94
95
96
97
98
99
100
    /** Set left Preconditioner
     *
     *  It is assumed that the solver owns the preconditioner from this call.
     *  That means that the preconditioner is deleted by the solver when not needed.
     */
    void setLeftPrecon(ITL_BasePreconditioner* p) 
    {
	if (leftPrecon) delete leftPrecon;
	leftPrecon= p;
    }
101

102
103
104
105
106
107
108
109
110
111
    /** Set right Preconditioner
     *
     *  It is assumed that the solver owns the preconditioner from this call.
     *  That means that the preconditioner is deleted by the solver when not needed.
     */
    void setRightPrecon(ITL_BasePreconditioner* p) 
    {
	if (rightPrecon) delete rightPrecon;
	rightPrecon= p;
    }
112

113
114
115
116
117
    /// Linear System to be solved in the derived class
    virtual int solveSystem(const DOFMatrix::base_matrix_type&      A,
			    mtl::dense_vector<value_type>&          x,
			    const mtl::dense_vector<value_type>&    b) = 0;
    
118

119
120
121
122
123
    /// Solve a linear system for a scalar problem.
    int solveSystem(const SolverMatrix<DOFMatrix>& A,
		    DOFVector<double>&             x, 
		    DOFVector<double>&             b) 
    {
Thomas Witkowski's avatar
Thomas Witkowski committed
124
125
126
127
128
129
      mtl::dense_vector<value_type>   xx(x.getUsedSize()),
	                              bb(b.getUsedSize());

      // Copy rhs vector
      int counter = 0;
      DOFVector<double>::Iterator it_b(&b, USED_DOFS);
130
      DOFVector<double>::Iterator it_x(&x, USED_DOFS);
131

132
133
134
135
136
      for (it_b.reset(), it_x.reset(); !it_b.end(); ++it_b, ++it_x) {	
	bb[counter] = *it_b;
	xx[counter] = *it_x;
	counter++;
      }
137

Thomas Witkowski's avatar
Thomas Witkowski committed
138
139
140
141
142
143
144
145
      int r = solveSystem(A.getMatrix(), xx, bb);

      // Copy solution vector to DOFVector
      counter = 0;
      for (it_x.reset(); !it_x.end(); ++it_x)
	*it_x = xx[counter++];

      return r;
146
    }
147

148
    /// Solve a linear system for a vectorial problem.
149
150
151
    virtual int solveSystem(const SolverMatrix<Matrix<DOFMatrix*> >& A,
			    SystemVector& x, 
			    SystemVector& b) 
152
    {
153
154
      int ns = x.getSize(),  // Number of systems.
	size = x.getUsedSize(); // Size of all DOFVectors
155
156
157
158

      // Copy vectors
      mtl::dense_vector<value_type>   xx(size), bb(size);
      for (int i = 0, counter = 0; i < ns; i++) {
159
160
161
162
163
164
165
166
	DOFVector<double>::Iterator it_b(b.getDOFVector(i), USED_DOFS);	  
	DOFVector<double>::Iterator it_x(x.getDOFVector(i), USED_DOFS);
	
	for (it_b.reset(), it_x.reset(); !it_b.end(); ++it_b, ++it_x) {	
	  bb[counter] = *it_b;
	  xx[counter] = *it_x;
	  counter++;
	}
167
      }
168
      
169
      // Solver on DOFVector for single system
170
      int r = solveSystem(A.getMatrix(), xx, bb);
171
      
172
      for (int i = 0, counter = 0; i < ns; i++) {
173
174
175
	DOFVector<double>::Iterator it(x.getDOFVector(i), USED_DOFS);	  
	for (it.reset(); !it.end(); ++it)	
	  *it = xx[counter++];	
176
      }
177
      
178
      return r;
179
    }
180
181
182
183
184

    /** \name getting methods
     * \{ 
     */

185
    /// Returns solvers \ref name.
186
    inline std::string getName() const
187
    { 
188
      return name; 
189
    }
190

191
    /// Returns \ref tolerance
192
    inline double getTolerance() const
193
    {
194
      return tolerance;
195
    }  
196

197
    /// Returns \ref max_iter
198
    inline int getMaxIterations() const
199
    {
200
      return max_iter;
201
    }
202

203
    /// Returns \ref residual
204
    inline double getResidual() const
205
    {
206
      return residual;
207
    }
208
209
210
211
212
213
214

    /** \} */ 

    /** \name setting methods
     * \{ 
     */

215
    /// Sets \ref tolerance
216
217
    inline void setTolerance(double tol) 
    {
218
      tolerance = tol;
219
    }
220

221
    /// Sets \ref relative
Thomas Witkowski's avatar
Thomas Witkowski committed
222
    inline void setRelative(double rel) 
223
    {
224
      relative = rel;
225
    }
226

227
    /// Sets \ref max_iter
228
229
    inline void setMaxIterations(int i) 
    {
230
      max_iter = i;
231
    }
232

233
234
235
236
237
238
239
240
241
242
243
244
    /// Returns number of iterations in last run of an iterative solver
    inline int getIterations() 
    {
	return iterations;
    }

    /// Returns error code in last run of an iterative solver
    inline int getErrorCode() 
    {
	return error;
    }

245
    /// Sets \ref info
246
247
    inline void setInfo(int i) 
    {
248
      info = i;
249
    }
250
251
252
253

    /** \} */

  protected:
254
    /// solvers name.
255
    std::string name;
256

257
    /// Solver tolerance |r|. Set in OEMSolver's constructor. 
258
259
    double tolerance;

260
    /// Relative solver tolerance |r|/|r0|. Set in OEMSolver's constructor. 
261
    double relative;
262

263
    /// maximal number of iterations. Set in OEMSolver's constructor.
264
265
    int max_iter;

266
    /// info level during solving the system. Set in OEMSolver's constructor.
267
268
    int info;

269
    /// current residual.
270
271
    double residual;

272
273
    /// Print cycle, after how many iterations the residuum norm is logged.
    int print_cycle;
274

275
276
277
278
279
280
281
    /// How many iterations were performed in last solver (not set by UmfPack)
    int iterations;

    /// Error code  in last solver (not set by UmfPack)
    int error;

    /// Left preconditioner (ignored by some iterative solvers and by UmfPack)
282
    ITL_BasePreconditioner *leftPrecon;
283

284
    /// Right preconditioner (ignored by some iterative solvers and by UmfPack)
285
    ITL_BasePreconditioner *rightPrecon;
286
287
288
289
290
291
292
293
  };

  /** 
   * \ingroup Solver
   *
   * \brief
   * Interface for creators of concrete OEMSolvers. 
   */
294
  class OEMSolverCreator : public CreatorInterface<OEMSolver>
295
296
  { 
  public:
297
    virtual ~OEMSolverCreator() {}
298

299
    /// Sets \ref problem
300
301
    void setName(std::string str) 
    { 
302
      name = str; 
303
    }
304
305
306
307
308
309

  protected:
    /** \brief
     * Pointer to the problem the solver will belong to. Needed as parameter
     * when constructing an OEMSolver
     */
310
    std::string name;
311
312
313
  };
}

314
#include "ITL_Solver.h"
315
316

#endif // AMDIS_OEM_SOLVER_H