Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Tempus_StepperState.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ****************************************************************************
3 // Tempus: Copyright (2017) Sandia Corporation
4 //
5 // Distributed under BSD 3-clause license (See accompanying file Copyright.txt)
6 // ****************************************************************************
7 // @HEADER
8 
9 #ifndef Tempus_StepperState_hpp
10 #define Tempus_StepperState_hpp
11 
12 #include "Teuchos_VerboseObject.hpp"
13 #include "Teuchos_Describable.hpp"
14 #include <string>
15 
16 #include "Tempus_config.hpp"
17 
18 namespace Tempus {
19 
20 template<class Scalar>
37 class StepperState :
38  public Teuchos::Describable,
39  public Teuchos::VerboseObject<Tempus::StepperState<Scalar> >
40 
41 {
42 public:
44  StepperState(std::string name = "Default") : stepperName_(name){}
45 
48  {
51  return ss_out;
52  }
53 
55  virtual void copy(const Teuchos::RCP<const StepperState<Scalar> >& ss)
56  {
57  stepperName_ = ss->stepperName_;
58  }
59 
61 
62  virtual std::string description() const { return "Tempus::StepperState"; }
63 
64  virtual void describe(Teuchos::FancyOStream & out,
65  const Teuchos::EVerbosityLevel /* verbLevel */) const
66  {
67  out << description() << "::describe" << std::endl
68  << " stepperName = " << stepperName_ << std::endl;
69  }
71 
72  std::string stepperName_;
73 
74 };
75 } // namespace Tempus
76 #endif // Tempus_StepperState_hpp
virtual std::string description() const
StepperState is a simple class to hold state information about the stepper.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel) const
virtual void copy(const Teuchos::RCP< const StepperState< Scalar > > &ss)
This is a deep copy.
virtual Teuchos::RCP< StepperState< Scalar > > clone() const
Clone copy constructor.
std::string stepperName_
Name of the creating Stepper.
StepperState(std::string name="Default")
Constructor.