Tempus_SolutionStateMetaData_decl.hpp

Go to the documentation of this file.

//@HEADER
// *****************************************************************************
//          Tempus: Time Integration and Sensitivity Analysis Package
//
// Copyright 2017 NTESS and the Tempus contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
//@HEADER

#ifndef Tempus_SolutionStateMetaData_decl_hpp
#define Tempus_SolutionStateMetaData_decl_hpp

// Teuchos
#include "Teuchos_VerboseObject.hpp"
#include "Teuchos_Describable.hpp"
// Tempus
#include "Tempus_config.hpp"
#include "Tempus_Types.hpp"

namespace Tempus {

template <class Scalar>
class SolutionStateMetaData
  : public Teuchos::Describable,
    public Teuchos::VerboseObject<Tempus::SolutionStateMetaData<Scalar> > {
 public:
  SolutionStateMetaData();

  SolutionStateMetaData(const Scalar time, const int iStep, const Scalar dt,
                        const Scalar errorAbs, const Scalar errorRel,
                        const Scalar errorRelNm1, const Scalar errorRelNm2,
                        const int order, const int nFailures,
                        const int nRunningFailures,
                        const int nConsecutiveFailures, const Scalar tolRel,
                        const Scalar tolAbs, const Scalar xNormL2,
                        const Scalar dxNormL2Rel, const Scalar dxNormL2Abs,
                        const bool computeNorms, const Status solutionStatus,
                        const bool output, const bool outputScreen,
                        const bool isSynced, const bool isInterpolated,
                        const Scalar accuracy);

  SolutionStateMetaData(const SolutionStateMetaData<Scalar>& ssmd);

  Teuchos::RCP<SolutionStateMetaData<Scalar> > clone() const;

  void copy(const Teuchos::RCP<const SolutionStateMetaData<Scalar> >& ssmd);

  virtual ~SolutionStateMetaData() {}


  Scalar getTime() const { return time_; }
  int getIStep() const { return iStep_; }
  Scalar getDt() const { return dt_; }
  Scalar getErrorAbs() const { return errorAbs_; }
  Scalar getErrorRel() const { return errorRel_; }
  Scalar getErrorRelNm1() const { return errorRelNm1_; }
  Scalar getErrorRelNm2() const { return errorRelNm2_; }
  Scalar getOrder() const { return order_; }
  int getNFailures() const { return nFailures_; }
  int getNRunningFailures() const { return nRunningFailures_; }
  int getNConsecutiveFailures() const { return nConsecutiveFailures_; }
  Scalar getTolAbs() const { return tolAbs_; }
  Scalar getTolRel() const { return tolRel_; }
  Scalar getXNormL2() const { return xNormL2_; }
  Scalar getDxNormL2Abs() const { return dxNormL2Abs_; }
  Scalar getDxNormL2Rel() const { return dxNormL2Rel_; }
  bool getComputeNorms() const { return computeNorms_; }
  Status getSolutionStatus() const { return solutionStatus_; }
  bool getOutput() const { return output_; }
  bool getOutputScreen() const { return outputScreen_; }
  bool getIsSynced() const { return isSynced_; }
  bool getIsInterpolated() const { return isInterpolated_; }
  Scalar getAccuracy() const { return accuracy_; }

  void setTime(Scalar time) { time_ = time; }
  void setIStep(int iStep) { iStep_ = iStep; }
  void setDt(Scalar dt) { dt_ = dt; }
  void setErrorAbs(Scalar errorAbs) { errorAbs_ = errorAbs; }
  void setErrorRel(Scalar errorRel)
  {
    errorRelNm2_ = errorRelNm1_;
    errorRelNm1_ = errorRel_;
    errorRel_    = errorRel;
  }
  void setErrorRelNm1(Scalar errorRelNm1) { errorRelNm1_ = errorRelNm1; }
  void setErrorRelNm2(Scalar errorRelNm2) { errorRelNm2_ = errorRelNm2; }
  void setOrder(Scalar order) { order_ = order; }
  void setNFailures(int nFailures) { nFailures_ = nFailures; }
  void setNRunningFailures(int nFailures) { nRunningFailures_ = nFailures; }
  void setNConsecutiveFailures(int nConsecutiveFailures)
  {
    nConsecutiveFailures_ = nConsecutiveFailures;
  }
  void setTolRel(Scalar tolRel) { tolRel_ = tolRel; }
  void setTolAbs(Scalar tolAbs) { tolAbs_ = tolAbs; }
  void setXNormL2(Scalar xNormL2) { xNormL2_ = xNormL2; }
  void setDxNormL2Rel(Scalar dxNormL2Rel) { dxNormL2Rel_ = dxNormL2Rel; }
  void setDxNormL2Abs(Scalar dxNormL2Abs) { dxNormL2Abs_ = dxNormL2Abs; }
  void setComputeNorms(bool computeNorms) { computeNorms_ = computeNorms; }
  void setSolutionStatus(Status solutionStatus)
  {
    solutionStatus_ = solutionStatus;
  }
  void setOutput(bool output) { output_ = output; }
  void setOutputScreen(bool outputScreen) { outputScreen_ = outputScreen; }
  void setIsSynced(bool isSynced) { isSynced_ = isSynced; }
  void setIsInterpolated(bool isInterpolated)
  {
    isInterpolated_ = isInterpolated;
  }
  void setAccuracy(Scalar accuracy) { accuracy_ = accuracy; }


  virtual std::string description() const;
  virtual void describe(Teuchos::FancyOStream& out,
                        const Teuchos::EVerbosityLevel verbLevel) const;

 protected:
  Scalar time_;               
  int iStep_;                 
  Scalar dt_;                 
  Scalar errorAbs_;           
  Scalar errorRel_;           
  Scalar errorRelNm1_;        
  Scalar errorRelNm2_;        
  Scalar order_;              
  int nFailures_;             
  int nRunningFailures_;      
  int nConsecutiveFailures_;  
  Scalar tolRel_;             
  Scalar tolAbs_;             
  Scalar xNormL2_;            
  Scalar dxNormL2Rel_;        
  Scalar dxNormL2Abs_;        
  bool computeNorms_;         

  Status solutionStatus_;
  bool output_;        
  bool outputScreen_;  

  bool isSynced_;
  bool isInterpolated_;  
  Scalar accuracy_;      
};

}  // namespace Tempus

#endif  // Tempus_SolutionStateMetaData_decl_hpp