AdaptInfo.hpp 17.8 KB
Newer Older
1
2
3
#pragma once

// std c++ headers
4
#include <algorithm>
5
#include <cmath>
6
#include <limits>
7
#include <map>
8
#include <string>
9
#include <utility>
10
11

// AMDiS includes
12
#include <amdis/Output.hpp>
13
#include <amdis/common/ConceptsBase.hpp>
14
#include <amdis/common/Math.hpp>
15
#include <amdis/utility/TreePath.hpp>
16
17
18
19
20
21
22
23

namespace AMDiS
{

  /**
   * \ingroup Adaption
   *
   * \brief
24
   * Holds adapt parameters and infos about the problem.
25
26
27
   */
  class AdaptInfo
  {
28
29
30
  public:
    using Key = std::string;

31
32
33
34
35
36
37
38
39
  protected:
    /** \brief
     * Stores adapt infos for a scalar problem or for one component of a
     * vector valued problem.
     */
    class ScalContent
    {
    public:
      /// Constructor.
40
      explicit ScalContent(std::string const& prefix);
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

      /// Sum of all error estimates
      double est_sum = 0.0;

      /// Sum of all time error estimates
      double est_t_sum = 0.0;

      /// maximal local error estimate.
      double est_max = 0.0;

      /// Maximum of all time error estimates
      double est_t_max = 0.0;

      /// factors to combine max and integral time estimate
      double fac_max = 0.0, fac_sum = 1.0;

      /// Tolerance for the (absolute or relative) error
      double spaceTolerance = 0.0;

      /// Time tolerance.
      double timeTolerance = 0.0;

      /// Relative time tolerance
      double timeRelativeTolerance = 0.0;

      /// Lower bound for the time error.
      double timeErrLow = 0.0;

      /// true if coarsening is allowed, false otherwise.
      int coarsenAllowed = 0;

      /// true if refinement is allowed, false otherwise.
      int refinementAllowed = 1;
    };

  public:
    /// Constructor.
78
    explicit AdaptInfo(std::string const& name);
79
80

    /// Destructor.
81
    virtual ~AdaptInfo() = default;
82
83
84
85
86
87
88

    /// Resets all variables to zero (or something equivalent)
    void reset();

    /// Returns whether space tolerance is reached.
    virtual bool spaceToleranceReached() const
    {
89
90
      for (auto const& scalContent : scalContents)      {
        if (!(scalContent.second.est_sum < scalContent.second.spaceTolerance))
91
92
93
94
95
96
          return false;
      }

      return true;
    }

97
    /// Returns whether space tolerance of component associated with key is reached.
98
    virtual bool spaceToleranceReached(Key key) const
99
    {
100
      if (!(getScalContent(key).est_sum < getScalContent(key).spaceTolerance))
101
102
103
104
105
        return false;
      else
        return true;
    }

106
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
107
    bool spaceToleranceReached(const TP& tp) const
108
109
110
111
    {
      return spaceToleranceReached(to_string(tp));
    }

112
113
114
    /// Returns whether time tolerance is reached.
    virtual bool timeToleranceReached() const
    {
115
116
      for (auto const& scalContent : scalContents)
        if (!(getTimeEstCombined(scalContent.first) < scalContent.second.timeTolerance))
117
118
119
120
121
          return false;

      return true;
    }

122
    /// Returns whether time tolerance of component associated with key is reached.
123
    virtual bool timeToleranceReached(Key key) const
124
    {
125
      if (!(getTimeEstCombined(key) < getScalContent(key).timeTolerance))
126
127
128
129
130
        return false;
      else
        return true;
    }

131
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
132
    bool timeToleranceReached(const TP& tp) const
133
134
135
136
    {
      return timeToleranceReached(to_string(tp));
    }

137
138
139
    /// Returns whether time error is under its lower bound.
    virtual bool timeErrorLow() const
    {
140
141
      for (auto const& scalContent : scalContents)
        if (!(getTimeEstCombined(scalContent.first) < scalContent.second.timeErrLow))
142
143
144
145
          return false;

      return true;
    }
146

147
148
    /// Returns the time estimation as a combination
    /// of maximal and integral time error
149
    double getTimeEstCombined(Key key) const
150
151
    {
      return
152
153
        getScalContent(key).est_t_max * getScalContent(key).fac_max +
        getScalContent(key).est_t_sum * getScalContent(key).fac_sum;
154
155
    }

156
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
157
    double getTimeEstCombined(const TP& tp) const
158
159
160
    {
      return getTimeEstCombined(to_string(tp));
    }
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
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285

    /// Print debug information about time error and its bound.
    void printTimeErrorLowInfo() const;

    /// Returns \ref spaceIteration.
    int getSpaceIteration() const
    {
      return spaceIteration;
    }

    /// Sets \ref spaceIteration.
    void setSpaceIteration(int it)
    {
      spaceIteration = it;
    }

    /// Returns \ref maxSpaceIteration.
    int getMaxSpaceIteration() const
    {
      return maxSpaceIteration;
    }

    /// Sets \ref maxSpaceIteration.
    void setMaxSpaceIteration(int it)
    {
      maxSpaceIteration = it;
    }

    /// Increments \ref spaceIteration by 1;
    void incSpaceIteration()
    {
      spaceIteration++;
    }

    /// Sets \ref timestepIteration.
    void setTimestepIteration(int it)
    {
      timestepIteration = it;
    }

    /// Returns \ref timestepIteration.
    int getTimestepIteration() const
    {
      return timestepIteration;
    }

    /// Increments \ref timestepIteration by 1;
    void incTimestepIteration()
    {
      timestepIteration++;
    }

    /// Returns \ref maxTimestepIteration.
    int getMaxTimestepIteration() const
    {
      return maxTimestepIteration;
    }

    /// Sets \ref maxTimestepIteration.
    void setMaxTimestepIteration(int it)
    {
      maxTimestepIteration = it;
    }

    /// Sets \ref timeIteration.
    void setTimeIteration(int it)
    {
      timeIteration = it;
    }

    /// Returns \ref timeIteration.
    int getTimeIteration() const
    {
      return timeIteration;
    }

    /// Increments \ref timesIteration by 1;
    void incTimeIteration()
    {
      timeIteration++;
    }

    /// Returns \ref maxTimeIteration.
    int getMaxTimeIteration() const
    {
      return maxTimeIteration;
    }

    /// Sets \ref maxTimeIteration.
    void setMaxTimeIteration(int it)
    {
      maxTimeIteration = it;
    }

    /// Returns \ref timestepNumber.
    int getTimestepNumber() const
    {
      return timestepNumber;
    }

    /// Sets \ref timestepNumber.
    void setTimestepNumber(int num)
    {
      timestepNumber = std::min(nTimesteps, num);
    }

    /// Returns \ref nTimesteps.
    int getNumberOfTimesteps() const
    {
      return nTimesteps;
    }

    /// Sets \ref nTimesteps.
    void setNumberOfTimesteps(int num)
    {
      nTimesteps = std::max(0, num);
    }

    /// Increments \ref timestepNumber by 1;
    void incTimestepNumber()
    {
      timestepNumber++;
    }

    /// Sets \ref est_sum.
286
    void setEstSum(double e, Key key)
287
    {
288
      getScalContent(key).est_sum = e;
289
290
    }

291
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
292
    void setEstSum(double e, const TP& tp)
293
294
295
296
    {
      setEstSum(e, to_string(tp));
    }

297
    /// Sets \ref est_max.
298
    void setEstMax(double e, Key key)
299
    {
300
      getScalContent(key).est_max = e;
301
302
    }

303
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
304
    void setEstMax(double e, const TP& tp)
305
306
307
308
    {
      setEstMax(e, to_string(tp));
    }

309
    /// Sets \ref est_max.
310
    void setTimeEstMax(double e, Key key)
311
    {
312
      getScalContent(key).est_t_max = e;
313
314
    }

315
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
316
    void setTimeEstMax(double e, const TP& tp)
317
318
319
320
    {
      setTimeEstMax(e, to_string(tp));
    }

321
    /// Sets \ref est_t_sum.
322
    void setTimeEstSum(double e, Key key)
323
    {
324
      getScalContent(key).est_t_sum = e;
325
326
    }

327
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
328
    void setTimeEstSum(double e, const TP& tp)
329
330
331
332
    {
      setTimeEstSum(e, to_string(tp));
    }

333
    /// Returns \ref est_sum.
334
    double getEstSum(Key key) const
335
    {
336
      return getScalContent(key).est_sum;
337
338
    }

339
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
340
    double getEstSum(const TP& tp)
341
342
343
344
    {
      return getEstSum(to_string(tp));
    }

345
    /// Returns \ref est_t_sum.
346
    double getEstTSum(Key key) const
347
    {
348
      return getScalContent(key).est_t_sum;
349
350
    }

351
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
352
    double getEstTSum(const TP& tp)
353
354
355
356
    {
      return getEstTSum(to_string(tp));
    }

357
    /// Returns \ref est_max.
358
    double getEstMax(Key key) const
359
    {
360
      return getScalContent(key).est_max;
361
362
    }

363
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
364
    double getEstMax(const TP& tp)
365
366
367
368
    {
      return getEstMax(to_string(tp));
    }

369
    /// Returns \ref est_max.
370
    double getTimeEstMax(Key key) const
371
    {
372
      return getScalContent(key).est_t_max;
373
374
    }

375
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
376
    double getTimeEstmax(const TP& tp)
377
378
379
380
    {
      return getTimeEstMax(to_string(tp));
    }

381
    /// Returns \ref est_t_sum.
382
    double getTimeEstSum(Key key) const
383
    {
384
      return getScalContent(key).est_t_sum;
385
386
    }

387
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
388
    double getTimeEstSum(const TP& tp)
389
390
391
392
    {
      return getTimeEstSum(to_string(tp));
    }

393
394
395
396
397
398
399
400
401
402
403
404
    /// Returns \ref est_t the estimated overall time error
    double getTimeEst() const
    {
      return est_t;
    }

    void setTimeEst(double value)
    {
      est_t = value;
    }

    /// Returns \ref spaceTolerance.
405
    double getSpaceTolerance(Key key) const
406
    {
407
      return getScalContent(key).spaceTolerance;
408
409
    }

410
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
411
    double getSpaceTolerance(const TP& tp)
412
413
414
415
    {
      return getSpaceTolerance(to_string(tp));
    }

416
    /// Sets \ref spaceTolerance.
417
    void setSpaceTolerance(Key key, double tol)
418
    {
419
      getScalContent(key).spaceTolerance = tol;
420
421
    }

422
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
423
    void setSpaceTolerance(const TP& tp, double tol)
424
425
426
427
    {
      return setSpaceTolerance(to_string(tp), tol);
    }

428
    /// Returns \ref timeTolerance.
429
    double getTimeTolerance(Key key) const
430
    {
431
      return getScalContent(key).timeTolerance;
432
433
    }

434
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
435
    double getTimeTolerance(const TP& tp)
436
437
438
439
    {
      return getTimeTolerance(to_string(tp));
    }

440
    /// Returns \ref timeRelativeTolerance.
441
    double getTimeRelativeTolerance(Key key) const
442
    {
443
      return getScalContent(key).timeRelativeTolerance;
444
445
    }

446
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
447
    double getTimeRelativeTolerance(const TP& tp)
448
449
450
451
    {
      return getTimeRelativeTolerance(to_string(tp));
    }

452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
    /// Sets \ref time
    double setTime(double t)
    {
      time = t;
      if (time > endTime)
        time = endTime;
      if (time < startTime)
        time = startTime;

      return time;
    }

    /// Gets \ref time
    double getTime() const
    {
      return time;
    }

    /// Gets \ref &time
471
    double const* getTimePtr() const
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
    {
      return &time;
    }

    /// Sets \ref timestep
    double setTimestep(double t)
    {
      timestep = t;
      if (timestep > maxTimestep)
        timestep = maxTimestep;
      if (timestep < minTimestep)
        timestep = minTimestep;
      if (time + timestep > endTime)
        timestep = endTime - time;

      return timestep;
    }
    /// Gets \ref timestep
    double getTimestep() const
    {
      return timestep;
    }

    void setLastProcessedTimestep(double t)
    {
      lastProcessedTimestep = t;
    }

    double getLastProcessedTimestep() const
    {
      return lastProcessedTimestep;
    }

    /// Returns true, if the end time is reached and no more timestep
    /// computations must be done.
    bool reachedEndTime() const
    {
      if (nTimesteps > 0)
        return !(timestepNumber < nTimesteps);

512
      return !(std::abs(time - endTime) > std::numeric_limits<double>::epsilon());
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
    }


    /// Sets \ref minTimestep
    void setMinTimestep(double t)
    {
      minTimestep = t;
    }

    /// Gets \ref minTimestep
    double getMinTimestep() const
    {
      return minTimestep;
    }

    /// Sets \ref maxTimestep
    void setMaxTimestep(double t)
    {
      maxTimestep = t;
    }

    /// Gets \ref maxTimestep
    double getMaxTimestep() const
    {
      return maxTimestep;
    }

    /// Gets \ref &timestep
541
    double const* getTimestepPtr() const
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
    {
      return &timestep;
    }

    /// Sets \ref startTime = time
    void setStartTime(double time)
    {
      startTime = time;
    }

    /// Sets \ref endTime = time
    void setEndTime(double time)
    {
      endTime = time;
    }

    /// Returns \ref startTime
    double getStartTime() const
    {
      return startTime;
    }

    /// Returns \ref endTime
    double getEndTime() const
    {
      return endTime;
    }

    /// Returns \ref timeErrLow.
571
    double getTimeErrLow(Key key) const
572
    {
573
      return getScalContent(key).timeErrLow;
574
575
    }

576
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
577
    double getTimeErrLow(const TP& tp)
578
579
580
581
    {
      return getTimeErrLow(to_string(tp));
    }

582
    /// Returns whether coarsening is allowed or not.
583
    bool isCoarseningAllowed(Key key) const
584
    {
585
      return (getScalContent(key).coarsenAllowed == 1);
586
587
    }

588
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
589
    bool isCoarseningAllowed(const TP& tp)
590
591
592
593
    {
      return isCoarseningAllowed(to_string(tp));
    }

594
    /// Returns whether coarsening is allowed or not.
595
    bool isRefinementAllowed(Key key) const
596
    {
597
      return (getScalContent(key).refinementAllowed == 1);
598
599
    }

600
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
601
    bool isRefinementAllowed(const TP& tp)
602
603
604
605
    {
      return isRefinementAllowed(to_string(tp));
    }

606
    ///
607
    void allowRefinement(bool allow, Key key)
608
    {
609
      getScalContent(key).refinementAllowed = allow;
610
611
    }

612
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
613
    void allowRefinement(bool allow, const TP& tp)
614
615
616
617
    {
      return allowRefinement(allow, to_string(tp));
    }

618
    ///
619
    void allowCoarsening(bool allow, Key key)
620
    {
621
      getScalContent(key).coarsenAllowed = allow;
622
623
    }

624
    template <class TP, REQUIRES( Concepts::PreTreePath<TP> )>
625
    void allowCoarsening(bool allow, const TP& tp)
626
627
628
629
    {
      return allowCoarsening(allow, to_string(tp));
    }

630
631
    int getSize() const
    {
632
      return int(scalContents.size());
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
    }

    // TODO: remove from AdaptInfo
    bool getRosenbrockMode() const
    {
      return rosenbrockMode;
    }

    void setSolverIterations(int it)
    {
      solverIterations = it;
    }

    int getSolverIterations() const
    {
      return solverIterations;
    }

    void setMaxSolverIterations(int it)
    {
      maxSolverIterations = it;
    }

    int getMaxSolverIterations() const
    {
      return maxSolverIterations;
    }

    void setSolverTolerance(double tol)
    {
      solverTolerance = tol;
    }

    double getSolverTolerance() const
    {
      return solverTolerance;
    }

    void setSolverResidual(double res)
    {
      solverResidual = res;
    }

    double getSolverResidual() const
    {
      return solverResidual;
    }

    void setGlobalTimeTolerance(double tol)
    {
      globalTimeTolerance = tol;
    }

    double getGlobalTimeTolerance() const
    {
      return globalTimeTolerance;
    }

    // TODO: remove from AdaptInfo
    void setRosenbrockMode(bool b)
    {
      rosenbrockMode = b;
    }

    /** \brief
     * Resets timestep, current time and time boundaries without
     * any check. Is used by the parareal algorithm.
     */
    void resetTimeValues(double newTimeStep,
                         double newStartTime,
                         double newEndTime)
    {
      time = newStartTime;
      startTime = newStartTime;
      endTime = newEndTime;
      timestep = newTimeStep;
      timestepNumber = 0;
    }

712
  private:
713
    ScalContent& getScalContent(Key key) const
714
    {
715
      auto result = scalContents.emplace(std::piecewise_construct, std::forward_as_tuple(key), std::forward_as_tuple(name_ + "[" + key + "]") );
716
717
718
      return result.first->second;
    }

719
720
  protected:
    /// Name.
721
    std::string name_;
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752

    /// Current space iteration
    int spaceIteration = -1;

    /** \brief
     * maximal allowed number of iterations of the adaptive procedure; if
     * maxIteration <= 0, no iteration bound is used
     */
    int maxSpaceIteration = -1;

    /// Current timestep iteration
    int timestepIteration = 0;

    /// Maximal number of iterations for choosing a timestep
    int maxTimestepIteration = 30;

    /// Current time iteration
    int timeIteration = 0;

    /// Maximal number of time iterations
    int maxTimeIteration = 30;

    /// Actual time, end of time interval for current time step
    double time = 0.0;

    /// Initial time
    double startTime = 0.0;

    /// Final time
    double endTime = 1.0;

753
    /// Time step size to be used
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
    double timestep = 0.0;

    /// Last processed time step size of finished iteration
    double lastProcessedTimestep = 0.0;

    /// Minimal step size
    double minTimestep = 0.0;

    /// Maximal step size
    double maxTimestep = 1.0;

    /// Number of current time step
    int timestepNumber = 0;

    /** \brief
     * Per default this value is 0 and not used. If it is set to a non-zero value,
     * the computation of the stationary problem is done nTimesteps times with a
     * fixed timestep.
     */
    int nTimesteps = 0;

    /// number of iterations needed of linear or nonlinear solver
    int solverIterations = 0;

    /// maximal number of iterations needed of linear or nonlinear solver
    int maxSolverIterations = 0;

    ///
    double solverTolerance = 1.e-8;

    ///
    double solverResidual = 0.0;

    /// tolerance for the overall time error
    double globalTimeTolerance = 1.0;

790
    /// Scalar adapt infos
791
    mutable std::map<Key, ScalContent> scalContents;
792
793
794
795
796
797
798
799
800
801
802
803

    /// Is true, if the adaptive procedure was deserialized from a file. TODO: remove deserialization
    bool deserialized = false;

    /// Is true, if the time adaption is controlled by a Rosenbrock Method.
    bool rosenbrockMode = false;

    /// overall time error estimate
    double est_t = 0.0;
  };

} // end namespace AMDiS