Tempus_StepperState.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_StepperState_hpp
#define Tempus_StepperState_hpp

#include "Teuchos_VerboseObject.hpp"
#include "Teuchos_Describable.hpp"
#include <string>

#include "Tempus_config.hpp"

namespace Tempus {

template <class Scalar>
class StepperState
  : public Teuchos::Describable,
    public Teuchos::VerboseObject<Tempus::StepperState<Scalar> >

{
 public:
  StepperState(std::string name = "Default") : stepperName_(name) {}

  virtual Teuchos::RCP<StepperState<Scalar> > clone() const
  {
    Teuchos::RCP<StepperState<Scalar> > ss_out =
        Teuchos::rcp(new StepperState<Scalar>(this->stepperName_));
    return ss_out;
  }

  virtual void copy(const Teuchos::RCP<const StepperState<Scalar> >& ss)
  {
    stepperName_ = ss->stepperName_;
  }


  virtual std::string description() const
  {
    return "Tempus::StepperState - '" + stepperName_ + "'";
  }

  virtual void describe(Teuchos::FancyOStream& out,
                        const Teuchos::EVerbosityLevel /* verbLevel */) const
  {
    auto l_out = Teuchos::fancyOStream(out.getOStream());
    Teuchos::OSTab ostab(*l_out, 2, this->description());
    l_out->setOutputToRootOnly(0);

    *l_out << "\n--- " << this->description() << " ---" << std::endl;
  }

  std::string stepperName_;  
};
}  // namespace Tempus
#endif  // Tempus_StepperState_hpp