OEMSolver.h 7.11 KB
Newer Older
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
// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
// ==  crystal growth group                                                  ==
// ==                                                                        ==
// ==  Stiftung caesar                                                       ==
// ==  Ludwig-Erhard-Allee 2                                                 ==
// ==  53175 Bonn                                                            ==
// ==  germany                                                               ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
// ==  http://www.caesar.de/cg/AMDiS                                         ==
// ==                                                                        ==
// ============================================================================

/** \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
67
68
69
    OEMSolver(std::string str) 
      : name(str),
	tolerance(0),
	relative(0),
	max_iter(1000),
	info(0),
	residual(0),
	print_cycle(100),
	leftPrecon(NULL),
	rightPrecon(NULL)
    {}
70
71

    /** \brief
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
124
125
126
127
    /// Solve a linear system for a scalar problem.
    int solveSystem(const SolverMatrix<DOFMatrix>& A,
		    DOFVector<double>&             x, 
		    DOFVector<double>&             b) 
    {
      mtl::dense_vector<value_type>   xx(x.getUsedSize(), &x[0]),
	                              bb(b.getUsedSize(), &b[0]);
      return solveSystem(A.getMatrix(), xx, bb);
    }
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
    /// 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++) {
	  DOFVector<double>::Iterator it(b.getDOFVector(i), USED_DOFS);	  
	  for (it.reset(); !it.end(); ++it)	
	      bb[counter++] = *it;	
      }

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

      for (int i = 0, counter = 0; i < ns; i++) {
	  DOFVector<double>::Iterator it(x.getDOFVector(i), USED_DOFS);	  
	  for (it.reset(); !it.end(); ++it)	
	      *it = xx[counter++];	
      }
      return r;
154
    }
155
156
157
158
159

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

160
    /// Returns solvers \ref name.
161
    inline const std::string& getName() { 
162
      return name; 
163
    }
164

165
    /// Returns \ref tolerance
166
167
    inline double getTolerance() {
      return tolerance;
168
    }  
169

170
    /// Returns \ref max_iter
171
172
    inline int getMaxIterations() {
      return max_iter;
173
    }
174

175
    /// Returns \ref residual
176
177
    inline double getResidual() {
      return residual;
178
    }
179
180
181
182
183
184
185

    /** \} */ 

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

186
    /// Sets \ref tolerance
187
    inline void setTolerance(double tol) {
188
      tolerance = tol;
189
    }
190

191
    /// Sets \ref relative
192
    inline void setRelative(bool rel) {
193
      relative = rel;
194
    }
195

196
    /// Sets \ref max_iter
197
    inline void setMaxIterations(int i) {
198
      max_iter = i;
199
    }
200

201
    /// Sets \ref info
202
    inline void setInfo(int i) {
203
      info = i;
204
    }
205
206
207
208

    /** \} */

  protected:
209
    /// solvers name.
210
    std::string name;
211

212
    /// Solver tolerance |r|. Set in OEMSolver's constructor. 
213
214
    double tolerance;

215
    /// Relative solver tolerance |r|/|r0|. Set in OEMSolver's constructor. 
216
    double relative;
217

218
    /// maximal number of iterations. Set in OEMSolver's constructor.
219
220
    int max_iter;

221
    /// info level during solving the system. Set in OEMSolver's constructor.
222
223
    int info;

224
    /// current residual.
225
226
    double residual;

227
228
    /// Print cycle, after how many iterations the residuum norm is logged.
    int print_cycle;
229

230
    ITL_BasePreconditioner *leftPrecon;
231

232
    ITL_BasePreconditioner *rightPrecon;
233
234
235
236
237
238
239
240
  };

  /** 
   * \ingroup Solver
   *
   * \brief
   * Interface for creators of concrete OEMSolvers. 
   */
241
  class OEMSolverCreator : public CreatorInterface<OEMSolver>
242
243
  { 
  public:
244
    virtual ~OEMSolverCreator() {}
245

246
    /// Sets \ref problem
247
248
    void setName(std::string str) { 
      name = str; 
249
    }
250
251
252
253
254
255

  protected:
    /** \brief
     * Pointer to the problem the solver will belong to. Needed as parameter
     * when constructing an OEMSolver
     */
256
    std::string name;
257
258
259
  };
}

260
#include "ITL_Solver.h"
261
262

#endif // AMDIS_OEM_SOLVER_H