Solver.h

Go to the documentation of this file.

// This file is part of the ExaHyPE2 project. For conditions of distribution and
// use, please see the copyright notice at www.peano-framework.org
#pragma once
 
 
#include <string>
 
#include "tarch/la/Vector.h"
#include "tarch/multicore/BooleanSemaphore.h"
 
 
namespace exahype2 {
  class Solver;
}
 
 
 
class exahype2::Solver {
  public:
    enum class Offloadable {
      Yes
    };
 
    Solver();
 
    virtual double getMinTimeStamp() const;
    virtual double getMaxTimeStamp() const;
    virtual double getMinTimeStepSize() const;
    virtual double getMaxTimeStepSize() const;
 
    virtual double getAdmissibleTimeStepSize() const;
 
    virtual void startTimeStep(
      double globalMinTimeStamp,
      double globalMaxTimeStamp,
      double globalMinTimeStepSize,
      double globalMaxTimeStepSize
    );
 
    virtual void finishTimeStep();
 
    virtual void startPlottingStep(
      double globalMinTimeStamp,
      double globalMaxTimeStamp,
      double globalMinTimeStepSize,
      double globalMaxTimeStepSize
    ) {}
 
    virtual void finishPlottingStep() {}
 
    virtual double getMaxMeshSize() const;
    virtual double getMinMeshSize() const;
 
    virtual std::string toCheckpointMetaData() const;
 
    static std::string toCheckpointMetaDataEntry(const std::string& key, double value);
 
    virtual void fromCheckpointMetaData(const std::string& metaData);
 
    static bool getCheckpointMetaDataEntry(const std::string& metaData, const std::string& key, double& value);
 
    virtual bool cellCanUseStatelessPDETerms(
      const tarch::la::Vector<Dimensions, double>& cellCentre,
      const tarch::la::Vector<Dimensions, double>& cellH,
      double                                       t,
      double                                       dt
    ) const;
 
    void updateCell(double timeStepSize, double timeStamp);
 
    void enforceTimeStepSize(double timeStepSize);
 
    void resetTimeStepSize();
 
  protected:
    double _minTimeStamp;
    double _maxTimeStamp;
 
    double _minTimeStampUpdatedThisTimeStep;
    double _maxTimeStampUpdatedThisTimeStep;
 
    double _minVolumeH;
    double _maxVolumeH;
 
    double _minVolumeHUpdatedThisTimeStep;
    double _maxVolumeHUpdatedThisTimeStep;
 
    double _minTimeStepSize;
    double _maxTimeStepSize;
 
    double _admissibleTimeStepSize;
 
    double _minTimeStepSizeUpdatedThisTimeStep;
    double _maxTimeStepSizeUpdatedThisTimeStep;
 
    int _cellUpdates;
 
    tarch::multicore::BooleanSemaphore _semaphore;
};