Tempus_PhysicsState_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_PhysicsState_hpp
#define Tempus_PhysicsState_hpp

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

namespace Tempus {

template <class Scalar>
class PhysicsState
  : public Teuchos::Describable,
    public Teuchos::VerboseObject<Tempus::PhysicsState<Scalar> > {
 public:
  PhysicsState(std::string pN = "Tempus::PhysicsState");

  virtual ~PhysicsState() {}

  virtual Teuchos::RCP<PhysicsState<Scalar> > clone() const;

  virtual void copy(const Teuchos::RCP<const PhysicsState<Scalar> >& pS);

  virtual std::string getName() const;

  virtual void setName(std::string pN);


  virtual std::string description() const;

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

 protected:
  std::string physicsName_;  
};
}  // namespace Tempus
#endif  // Tempus_PhysicsState_hpp