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

/** \file AdaptInstationary.h */

#ifndef AMDIS_ADAPTINSTATIONARY_H
#define AMDIS_ADAPTINSTATIONARY_H

#include <string>
#include <ctime>
#include <queue>
#include "Flag.h"
#include "MemoryManager.h"
#include "AdaptInfo.h"
#include "AdaptBase.h"

namespace AMDiS {

  class ProblemIterationInterface;
  class ProblemTimeInterface;

  // ============================================================================
  // ===== class AdaptInstationary ==============================================
  // ============================================================================

  /** \ingroup Adaption  
   * \brief
   * AdaptInstationary implements the adaptive procdure for time dependent 
   * problems (see ProblemInstat). It contains a pointer to a ProblemInstat
   * object.
   */
  class AdaptInstationary : public AdaptBase
  {
  public:
    MEMORY_MANAGED(AdaptInstationary);

    /** \brief
     * Creates a AdaptInstationary object with the given name for the time 
     * dependent problem problemInstat.
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
57
    AdaptInstationary(std::string name, 
58
		      ProblemIterationInterface *problemStat,
59
60
61
62
		      AdaptInfo *info,
		      ProblemTimeInterface *problemInstat,
		      AdaptInfo *initialInfo,
                      time_t initialTimestamp = 0);
63

Thomas Witkowski's avatar
Thomas Witkowski committed
64
    /// Destructor
65
66
    virtual ~AdaptInstationary();

Thomas Witkowski's avatar
Thomas Witkowski committed
67
    /// Sets \ref strategy to aStrategy
68
69
    inline void setStrategy(int aStrategy) { 
      strategy = aStrategy; 
70
    }
71

Thomas Witkowski's avatar
Thomas Witkowski committed
72
    /// Returns \ref strategy
73
74
    const int getStrategy() const {
      return strategy;
Thomas Witkowski's avatar
* Bla  
Thomas Witkowski committed
75
    }
76

Thomas Witkowski's avatar
Thomas Witkowski committed
77
    /// Implementation of AdaptBase::adapt()
78
79
    virtual int adapt();

Thomas Witkowski's avatar
Thomas Witkowski committed
80
    /// Serialization
81
    virtual void serialize(std::ostream &out);
82

Thomas Witkowski's avatar
Thomas Witkowski committed
83
    /// deserialization
84
    virtual void deserialize(std::istream &in);
85
86
87
88
89
90
91
92
93
94
95
96
97
98


  protected:
    /** \brief
     * Implements one (maybe adaptive) timestep. Both the explicit and the 
     * implicit time strategy are implemented. The semi-implicit strategy 
     * is only a special case of the implicit strategy with a limited number of 
     * iterations (exactly one).
     * The routine uses the parameter \ref strategy to select the strategy:
     * strategy 0: Explicit strategy, 
     * strategy 1: Implicit strategy.
     */
    virtual void oneTimestep();

Thomas Witkowski's avatar
Thomas Witkowski committed
99
    /// Initialisation of this AdaptInstationary object
100
    void initialize(const std::string& aName);
101

Thomas Witkowski's avatar
Thomas Witkowski committed
102
    /// Implements the explit time strategy. Used by \ref oneTimestep().
103
104
    virtual void explicitTimeStrategy();

Thomas Witkowski's avatar
Thomas Witkowski committed
105
    /// Implements the implicit time strategy. Used by \ref oneTimestep().
106
107
108
109
110
111
112
113
114
115
116
117
118
    virtual void implicitTimeStrategy();

    /** \brief
     * Checks whether the runtime of the queue (of the servers batch system) requires
     * to stop the calculation and to reschedule the problem to the batch system.
     *
     * The function return true, if there will be a timeout in the near future, and
     * therefore the problem should be rescheduled. Otherwise, the return value is
     * false.
     */
    bool checkQueueRuntime();

  protected:
Thomas Witkowski's avatar
Thomas Witkowski committed
119
    /// Strategy for choosing one timestep
120
121
    int strategy; 

Thomas Witkowski's avatar
Thomas Witkowski committed
122
    /// Parameter \f$ \delta_1 \f$ used in time step reduction
123
    double time_delta_1;
124

Thomas Witkowski's avatar
Thomas Witkowski committed
125
    /// Parameter \f$ \delta_2 \f$ used in time step enlargement
126
    double time_delta_2;
127
128
129
130
131
132
133

    /** \brief
     * If this parameter is 1 and the instationary problem is stable, hence the number
     * of solver iterations to solve the problem is zero, the adaption loop will stop.
     */
    int breakWhenStable;

Thomas Witkowski's avatar
Thomas Witkowski committed
134
    ///
135
136
137
138
139
140
141
142
    bool fixedTimestep_;

    /** \brief
     * Runtime of the queue (of the servers batch system) in seconds. If the problem
     * runs on a computer/server without a time limited queue, the value is -1.
     */
    int queueRuntime_;

Thomas Witkowski's avatar
Thomas Witkowski committed
143
    /// Name of the file used to automatically serialize the problem.
144
    std::string queueSerializationFilename_;
145
146

    /** \brief
Thomas Witkowski's avatar
Thomas Witkowski committed
147
148
     * Timestamp at the beginning of all calculations. It is used to calculate the 
     * overall runtime of the problem.
149
150
151
152
     */
    time_t initialTimestamp_;

    /** \brief
Thomas Witkowski's avatar
Thomas Witkowski committed
153
154
     * Timestamp at the beginning of the last timestep iteration. Is is used to 
     * calculate the runtime of the last timestep.
155
156
157
     */
    time_t iterationTimestamp_;

Thomas Witkowski's avatar
Thomas Witkowski committed
158
    /// Stores the runtime (in seconds) of some last timestep iterations.
159
    std::queue<int> lastIterationsDuration_;
160
161

    /** \brief
Thomas Witkowski's avatar
Thomas Witkowski committed
162
163
     * In debug mode, the adapt loop will print information about timestep decreasing 
     * and increasing.
164
165
     */
    bool dbgMode;
166
167
168
169
170
  };

}

#endif // AMDIS_ADAPTINSTATIONARY_H