OEMSolver.h 8.3 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
131
132
133
134
135
      DOFVector<double>::Iterator it_x(&x, 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++;
      }
Thomas Witkowski's avatar
Thomas Witkowski committed
136
137
138
139
140
141
142
143
144
	
      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;
145
    }
146

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

      // Copy vectors
      mtl::dense_vector<value_type>   xx(size), bb(size);
      for (int i = 0, counter = 0; i < ns; i++) {
158
159
160
161
162
163
164
165
	  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++;
	  }
166
167
168
      }

      // Solver on DOFVector for single system
169
      int r = solveSystem(A.getMatrix(), xx, bb);
170
171

      for (int i = 0, counter = 0; i < ns; i++) {
172
173
174
	DOFVector<double>::Iterator it(x.getDOFVector(i), USED_DOFS);	  
	for (it.reset(); !it.end(); ++it)	
	  *it = xx[counter++];	
175
      }
Thomas Witkowski's avatar
Thomas Witkowski committed
176

177
      return r;
178
    }
179
180
181
182
183

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

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

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

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

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

    /** \} */ 

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

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

220
    /// Sets \ref relative
221
222
    inline void setRelative(bool rel) 
    {
223
      relative = rel;
224
    }
225

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

232
233
234
235
236
237
238
239
240
241
242
243
    /// 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;
    }

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

    /** \} */

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

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

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

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

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

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

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

274
275
276
277
278
279
280
    /// 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)
281
    ITL_BasePreconditioner *leftPrecon;
282

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

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

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

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

313
#include "ITL_Solver.h"
314
315

#endif // AMDIS_OEM_SOLVER_H