Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Tempus_PhysicsStateCounter.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_PhysicsStateCounter_hpp
10 #define Tempus_PhysicsStateCounter_hpp
11 
12 #include "Teuchos_VerboseObject.hpp"
13 #include "Teuchos_Describable.hpp"
14 #include <string>
15 #include "Tempus_PhysicsState.hpp"
16 
17 namespace Tempus_Test {
18 
19 template <class Scalar>
23 class PhysicsStateCounter : virtual public Tempus::PhysicsState<Scalar> {
24  public:
26  PhysicsStateCounter(std::string pN = "Tempus::PhysicsStateCounter",
27  int pI = 0)
28  : Tempus::PhysicsState<Scalar>(pN), physicsCounter_(pI)
29  {
30  }
31 
33  virtual ~PhysicsStateCounter() {}
34 
37  {
40  this->physicsCounter_));
41  return pSC;
42  }
43 
44  // using Tempus::PhysicsState<Scalar>::copy;
46  virtual void copy(const Teuchos::RCP<const Tempus::PhysicsState<Scalar> >& pS)
47  {
49  Teuchos::rcp_dynamic_cast<const PhysicsStateCounter<Scalar> >(pS);
50 
51  this->physicsName_ = pSC->getName();
52  this->physicsCounter_ = pSC->getCounter();
53  }
54 
56  virtual int getCounter() const { return physicsCounter_; }
57 
59  virtual void setCounter(int counter) { physicsCounter_ = counter; }
60 
62 
63  virtual void describe(Teuchos::FancyOStream& out,
64  const Teuchos::EVerbosityLevel verbLevel) const
65  {
66  out << this->description() << "::describe" << std::endl
67  << " physicsName = " << this->physicsName_ << std::endl
68  << " physicsCounter = " << physicsCounter_ << std::endl;
69  }
71 
72  protected:
74 };
75 } // namespace Tempus_Test
76 #endif // Tempus_PhysicsStateCounter_hpp
PhysicsState is a simple class to hold information about the physics.
virtual int getCounter() const
Return counter of PhysicsStateCounter.
PhysicsStateCounter(std::string pN="Tempus::PhysicsStateCounter", int pI=0)
Constructor.
PhysicsState(std::string pN="Tempus::PhysicsState")
Constructor.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
virtual void copy(const Teuchos::RCP< const Tempus::PhysicsState< Scalar > > &pS)
This is a deep copy.
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
PhysicsStateCounter is a simple PhysicsState that counts steps.
virtual std::string description() const
std::string physicsName_
Name of the creating Physics.
virtual Teuchos::RCP< Tempus::PhysicsState< Scalar > > clone() const
Clone constructor.
virtual void setCounter(int counter)
Set counter of PhysicsStateCounter.