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

/** \file Estimator.h */

/** \defgroup Estimator Estimator module
 * @{ <img src="estimator.png"> @}
 */

#ifndef AMDIS_ESTIMATOR_H
#define AMDIS_ESTIMATOR_H

#include "Flag.h"
#include "Global.h"
#include "FixVec.h"
#include "SystemVector.h"
#include "CreatorInterface.h"

namespace AMDiS {

  class ElInfo;
  class Quadrature;
  class FastQuadrature;
  class BasisFunction;

  class ProblemInstat;
  template<typename T> class DOFVector;
  class RobinBC;
  class DOFMatrix;

  // ============================================================================
  // ===== class Estimator ======================================================
  // ============================================================================

  /**
   * \ingroup Estimator
   * 
   * \brief
   * Estimator for scalar problems.
   */
  class Estimator
  {
  public:
    MEMORY_MANAGED(Estimator);

    Estimator() {};

    /** \brief
     * Constructor.
     */
    Estimator(::std::string name_, int r);

    /** \brief
     * destructor
     */
    virtual ~Estimator() {};

    /** \brief
     * Returns \ref name of the Estimator
     */
    inline const ::std::string& getName() const { 
      return name; 
    };

    /** \brief
     * Performs the estimation and returns the final \ref est_sum
     */
    virtual double estimate(double timestep = 0.0);

86
87
88
    /** \brief
     *
     */
89
90
    virtual void init(double timestep) {};

91
92
93
    /** \brief
     *
     */
94
95
    virtual void estimateElement(ElInfo *elInfo) {};

96
97
98
99
    /** \brief
     *
     */
    virtual void exit(bool output=true) {};
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

    /** \brief
     * Returns \ref est_sum of the Estimator
     */
    inline double getErrorSum() const { 
      return est_sum; 
    };

    /** \brief
     * Sets \ref est_sum of the Estimator
     */
    inline void setErrorSum(double sum) { 
      est_sum = sum; 
    };

    /** \brief
     * Returns \ref est_max of the Estimator
     */
    inline double getErrorMax() const { 
      return est_max; 
    };

    /** \brief
     * Returns the estimated time error.
     */
    virtual double getTimeEst() const { 
      return est_t_sum; 
    };

    /** \brief
     * Returns the maximal time estimation.
     */
    virtual double getTimeEstMax() const { 
      return est_t_max; 
    };

    /** \brief
     * Sets \ref est_max of the Estimator
     */
    inline void setErrorMax(double m) { 
      est_max = m; 
    };

    /** \brief
     * Returns \ref norm.
     */
    inline Norm getErrorNorm() { 
      return norm; 
    };

    /** \brief
     * Adds one system to the estimator.
     */
153
154
155
156
    virtual void addSystem(DOFMatrix *matrix_,
			   DOFVector<double> *uh_,
			   DOFVector<double> *fh_,
			   DOFVector<double> *uhOld_ = NULL)
157
158
159
160
161
162
163
164
165
166
    {
      matrix.push_back(matrix_);
      uh.push_back(uh_);
      fh.push_back(fh_);
      uhOld.push_back(uhOld_);
    };

    /** \brief
     * Adds pointer to old solution to the given system.
     */
167
    virtual void addUhOldToSystem(int system, DOFVector<double> *uhOld_) 
168
169
170
171
172
173
174
175
176
177
178
179
180
    {
      TEST_EXIT(static_cast<int>(uhOld.size()) > system)("invalid system\n");
      TEST_EXIT(uhOld[system] == NULL)("there is already an uhOld\n");
      uhOld[system] = uhOld_;
    }

    /** \brief
     * Returns number of systems.
     */
    inline int getNumSystems() { 
      return static_cast<int>(matrix.size()); 
    };

181
182
183
    inline Flag getTraverseFlag() { 
      return traverseFlag; 
    };
184

185
186
187
188
189
190
191
    inline Mesh* getMesh() { 
      return mesh; 
    };

    inline int getRow() { 
      return row; 
    };  
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261

  protected:
    /** \brief
     * Name of the Estimator
     */
    ::std::string name;

    /** \brief
     * Used norm
     */
    Norm norm;
 
    /** \brief
     * Sum of all error estimates
     */
    double est_sum;

    /** \brief
     * Sum of all time error estimates
     */
    double est_t_sum;

    /** \brief
     * Max of all time error estimates
     */
    double est_t_max;

    /** \brief
     * Maximal error estimate
     */
    double est_max;

    /** \brief
     * Vector of DOFMatrix pointers. There can be more than one
     * DOFMatrix, if the Estimator is part of a vector valued 
     * estimator. Then it contains also coupling matrices
     * of the different vector components.
     */ 
    ::std::vector<DOFMatrix*> matrix;

    /** \brief
     * Vector of solution vectors for the different systems.
     */
    ::std::vector<DOFVector<double>*> uh;

    /** \brief
     * Vector of old solutions vectors for the different systems. 
     * Used for instationary problems.
     */
    ::std::vector<DOFVector<double>*> uhOld;

    /** \brief
     * Vector of RHS vectors for the different systems.
     */
    ::std::vector<DOFVector<double>*> fh;

    /** \brief
     * Used, if the scalar estimator builds one row of a vector valued estimator.
     * Then row gives the position in the vector valued estimator, used
     * for calculation of the time derivative.
     */
    int row;

    Flag traverseFlag;

    Mesh *mesh;

    double timestep;
  };

262

263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
  // ============================================================================
  // ===== class EstimatorCreator ===============================================
  // ============================================================================

  /** 
   * \ingroup Estimator
   *
   * \brief
   * Interface for creators of concrete estimators. 
   */
  class EstimatorCreator : public CreatorInterface<Estimator>
  { 
  public:
    /** \brief
     * constructor
     */
    EstimatorCreator() : row(-1) {};

    /** \brief
     * destructor
     */
    virtual ~EstimatorCreator() {};

    /** \brief
     * Sets \ref name
     */
289
290
291
    void setName(::std::string name_) { 
      name = name_; 
    };
292
293
294
295

    /** \brief
     * Sets \ref row
     */
296
297
298
    void setRow(int r) { 
      row = r; 
    };  
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314

  protected:
    /** \brief
     * Name of the estimator to be created.
     */
    ::std::string name;

    /** \brief
     * Row of the estimator.
     */
    int row;
  };

}

#endif // AMDIS_ESTIMATOR_H