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

/** \file ProblemInstat.h */

#ifndef AMDIS_PROBLEM_INSTAT_H_
#define AMDIS_PROBLEM_INSTAT_H_

#include "ProblemScal.h"
#include "ProblemVec.h"
#include "MemoryManager.h"
#include "ProblemTimeInterface.h"
#include "AdaptInstationary.h"

namespace AMDiS {

  // ===========================================================================
  // ===== class ProblemInstat =================================================
  // ===========================================================================

  /**
   * \ingroup Problem
   *
   * \brief
   * Base class for ProblemInstatScal and ProblemInstatVec.
   */
  class ProblemInstat : public ProblemTimeInterface,
			public ProblemStatBase
  {
  public:
    /** \brief
     * Constructor.
     */
50
    ProblemInstat(std::string name_,
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 86 87 88 89 90
		  ProblemStatBase *initialProb)
      : name(name_),
	initialProblem(initialProb ? initialProb : this)
    {};

    /** \brief
     * Destructor.
     */
    virtual ~ProblemInstat();


    /** \brief
     * Initialisation of the problem.
     */
    virtual void initialize(Flag initFlag,
			    ProblemInstat *adoptProblem = NULL,
			    Flag adoptFlag = INIT_NOTHING);

    /** \brief
     */
    virtual void solve(AdaptInfo *adaptInfo) {};

    /** \brief
     */
    virtual void estimate(AdaptInfo *adaptInfo) {};

    /** \brief
     */
    virtual void buildBeforeRefine(AdaptInfo *adaptInfo, Flag) {};

    /** \brief
     */
    virtual void buildBeforeCoarsen(AdaptInfo *adaptInfo, Flag) {};

    /** \brief
     */
    virtual void buildAfterCoarsen(AdaptInfo *adaptInfo, Flag) {};

    /** \brief
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
91 92 93
    virtual Flag markElements(AdaptInfo *adaptInfo) { 
      return 0; 
    };
94 95 96

    /** \brief
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
97 98 99
    virtual Flag refineMesh(AdaptInfo *adaptInfo) { 
      return 0; 
    };
100 101 102

    /** \brief
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
103 104 105
    virtual Flag coarsenMesh(AdaptInfo *adaptInfo) { 
      return 0; 
    };
106 107 108 109 110 111 112 113 114

    /** \brief
     * Implementation of ProblemTimeInterface::closeTimestep().
     */
    virtual void closeTimestep() {};

    /** \brief
     * Returns \ref name.
     */
115
    inline const std::string& getName() { 
Thomas Witkowski's avatar
Thomas Witkowski committed
116 117
      return name; 
    };
118 119 120 121 122 123

    /** \brief
     * Used by \ref problemInitial
     */
    virtual void solveInitialProblem(AdaptInfo *adaptInfo);  

Thomas Witkowski's avatar
Thomas Witkowski committed
124 125 126 127 128
    /** \brief
     * Implements the parallel file writing for instationary problems.
     */
    virtual void startDelayedTimestepCalculation() {};

129 130 131 132
  protected:
    /** \brief
     * Name of the problem.
     */
133
    std::string name;
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176

    ProblemStatBase *initialProblem;
  };

  // ===========================================================================
  // ===== class ProblemInstatScal =============================================
  // ===========================================================================

  /**
   * \ingroup Problem
   *
   * \brief
   * Standard implementation of ProblemTimeInterface for a time dependent problems.
   */
  class ProblemInstatScal : public ProblemInstat
  {
  public:
    MEMORY_MANAGED(ProblemInstatScal);

    /** \brief
     * Constructs a ProblemInstatScal with prob as its stationary problem.
     */
    ProblemInstatScal(char* name_, 
		      ProblemScal *prob,
		      ProblemStatBase *initialProb = NULL);

    /** \brief
     * Destructor.
     */
    virtual ~ProblemInstatScal();

    /** \brief
     * Initialisation of the problem.
     */
    virtual void initialize(Flag initFlag,
			    ProblemInstat *adoptProblem = NULL,
			    Flag adoptFlag = INIT_NOTHING);


    /** \brief
     * Used in \ref initialize().
     */
    virtual void createUhOld();
177
 
178 179 180 181 182 183 184 185 186 187 188 189 190
    /** \brief
     * Implementation of ProblemTimeInterface::initTimestep().
     */
    virtual void initTimestep(AdaptInfo *adaptInfo);

    /** \brief
     * Implementation of ProblemTimeInterface::closeTimestep().
     */
    virtual void closeTimestep(AdaptInfo *adaptInfo);
  
    /** \brief
     * Returns \ref problemStat.
     */
191 192 193
    inline ProblemScal* getStatProblem() { 
      return problemStat; 
    };
194 195 196 197

    /** \brief
     * Returns \ref oldSolution.
     */
198 199 200
    inline DOFVector<double> *getOldSolution() { 
      return oldSolution; 
    };
201 202 203 204 205 206

    /** \brief
     * Used by \ref problemInitial
     */
    virtual void transferInitialSolution(AdaptInfo *adaptInfo);  

Thomas Witkowski's avatar
Thomas Witkowski committed
207
    virtual void startDelayedTimestepCalculation();
208

Thomas Witkowski's avatar
Thomas Witkowski committed
209 210
    virtual bool existsDelayedCalculation();

211
    virtual void serialize(std::ostream &out) {};
212 213


214
    virtual void deserialize(std::istream &in) {};
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
   
  protected:
    /** \brief
     * Space problem solved in each timestep.
     */
    ProblemScal* problemStat;

    /** \brief
     * Solution of the last timestep.
     */
    DOFVector<double>* oldSolution;
  };


  // ===========================================================================
  // ===== class ProblemInstatVec ==============================================
  // ===========================================================================

  /**
   * \ingroup Problem
   *
   * \brief
   * Standard implementation of ProblemTimeInterface for a time dependent 
   * vector valued problems.
   */
  class ProblemInstatVec : public ProblemInstat
  {
  public:
    MEMORY_MANAGED(ProblemInstatVec);

    /** \brief
     * Constructs a ProblemInstatVec with prob as its stationary problem.
     */
    ProblemInstatVec(char       *name_, 
		     ProblemVec *prob,
		     ProblemStatBase *initialProb = NULL);

    /** \brief
     * Destructor.
     */
    virtual ~ProblemInstatVec();

    /** \brief
     * Initialisation of the problem.
     */
    virtual void initialize(Flag initFlag,
			    ProblemInstat *adoptProblem = NULL,
			    Flag adoptFlag = INIT_NOTHING);

    /** \brief
     * Used in \ref initialize().
     */
    virtual void createUhOld();

    /** \brief
     * Implementation of ProblemTimeInterface::initTimestep().
     */
    virtual void initTimestep(AdaptInfo *adaptInfo);

    /** \brief
     * Implementation of ProblemTimeInterface::closeTimestep().
     */
    virtual void closeTimestep(AdaptInfo *adaptInfo);
  
    /** \brief
     * Returns \ref problemStat.
     */
282 283 284
    inline ProblemVec* getStatProblem() { 
      return problemStat; 
    };
285 286 287 288

    /** \brief
     * Returns \ref oldSolution.
     */
289 290 291
    inline SystemVector *getOldSolution() { 
      return oldSolution; 
    };
292 293 294 295 296 297

    /** \brief
     * Used by \ref problemInitial
     */
    virtual void transferInitialSolution(AdaptInfo *adaptInfo);  

Thomas Witkowski's avatar
Thomas Witkowski committed
298 299
    virtual void startDelayedTimestepCalculation();

Thomas Witkowski's avatar
Thomas Witkowski committed
300 301
    virtual bool existsDelayedCalculation();

302
    virtual void serialize(std::ostream &out) {};
303

304
    virtual void deserialize(std::istream &in) {};
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320

  protected:
    /** \brief
     * Space problem solved in each timestep.
     */
    ProblemVec* problemStat;

    /** \brief
     * Solution of the last timestep.
     */
    SystemVector *oldSolution;
  };

}

#endif