Tempus_SolutionStateMetaData_decl.hpp

Go to the documentation of this file.

// @HEADER
// ****************************************************************************
//                Tempus: Copyright (2017) Sandia Corporation
//
// Distributed under BSD 3-clause license (See accompanying file Copyright.txt)
// ****************************************************************************
// @HEADER

#ifndef Tempus_SolutionStateMetaData_decl_hpp
#define Tempus_SolutionStateMetaData_decl_hpp

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


namespace Tempus {

/** \brief Solution state meta data.
 */
template<class Scalar>
class SolutionStateMetaData :
  public Teuchos::Describable,
  public Teuchos::VerboseObject<Tempus::SolutionStateMetaData<Scalar> >
{
public:

  /// Default constructor.
  SolutionStateMetaData();

  /// Constructor
  SolutionStateMetaData(
    const Scalar time,
    const int    iStep,
    const Scalar dt,
    const Scalar errorAbs,
    const Scalar errorRel,
    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);

  /// Copy constructor
  SolutionStateMetaData(const SolutionStateMetaData<Scalar>& ssmd);

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

  /// This is a deep copy
  void copy(const Teuchos::RCP<const SolutionStateMetaData<Scalar> >& ssmd);

  /// Destructor
  virtual ~SolutionStateMetaData() {}

  /// \name Accessor methods
  //@{
    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 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)         {errorRel_ = errorRel;}
    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;}
  //@}

  /// \name Overridden from Teuchos::Describable
  //@{
    virtual std::string description() const;
    virtual void describe(Teuchos::FancyOStream          &out,
                          const Teuchos::EVerbosityLevel verbLevel) const;
  //@}

protected:
  Scalar time_;              ///< Time of solution
  int    iStep_;             ///< Time step index for this solution
  Scalar dt_;                ///< Time step for this solution
  Scalar errorAbs_;          ///< Absolute local truncation error
  Scalar errorRel_;          ///< Relative local truncation error
  Scalar order_;             ///< Order of this solution
  int nFailures_;            ///< Total number of stepper failures
  int nRunningFailures_;     ///< Total number of running stepper failures
  int nConsecutiveFailures_; ///< Consecutive number of stepper failures
  Scalar tolRel_;            ///< Relative tolerance
  Scalar tolAbs_;            ///< Absolute tolerance
  Scalar xNormL2_;           ///< L2-Norm of the solution
  Scalar dxNormL2Rel_;       ///< Relative L2-Norm of the change in solution, ||x_i-x_{i-1}||/||x_{i-1}||
  Scalar dxNormL2Abs_;       ///< Absolute L2-Norm of the change in solution, ||x_i-x_{i-1}||
  bool   computeNorms_;      ///< flag to compute norms of solution

  /** \brief The solutionStatus is used to indicate
      - if the solution is still being worked on; WORKING
      - if the solution is accepted and completed (e.g., past solutions
        in SolutionHistory); PASSED.
      - if the time step has FAILED.  This may be caused by the Stepper
        failing, or Integrator not accepting the time step.
  */
  Status solutionStatus_;
  bool   output_;         ///< SolutionState should be or has been outputted
  bool   outputScreen_;   ///< Output screen dump
  /** \brief True - all of soln (x, xDot, xDotDot) is at the same time level.
   *  False - solution is at different time levels, e.g., leapfrog where
   *  \f$x_n\f$ and \f$\dot{x}_{n+1/2}\f$
   */
  bool   isSynced_;
  bool   isInterpolated_; ///< F - soln is time integrated; T - soln is interpolated
  Scalar accuracy_;       ///< Interpolation accuracy of solution

};
} // namespace Tempus

#endif // Tempus_SolutionStateMetaData_decl_hpp