MueLu_Describable.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//        MueLu: A package for multigrid based preconditioning
//
// Copyright 2012 NTESS and the MueLu contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef MUELU_DESCRIBABLE_DECL_HPP
#define MUELU_DESCRIBABLE_DECL_HPP

#include <string>                      // for string
#include "Teuchos_FancyOStream.hpp"    // for FancyOStream
#include "Teuchos_VerbosityLevel.hpp"  // for EVerbosityLevel
#include "Teuchos_Describable.hpp"

#include "MueLu_VerbosityLevel.hpp"

namespace MueLu {

class Describable
  : public Teuchos::Describable {
  mutable std::string shortClassName_ = "";  // cached so that we don't have to call demangleName() every time; mutable so that ShortClassName() can initialize lazily while remaining const

 public:
  virtual ~Describable();



  virtual void describe(Teuchos::FancyOStream &out_arg, const VerbLevel verbLevel = Default) const;




  virtual std::string description() const;

  void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel = Teuchos::Describable::verbLevel_default) const;


  virtual std::string ShortClassName() const;

};  // class Describable

}  // namespace MueLu

#define MUELU_DESCRIBABLE_SHORT
#endif  // MUELU_DESCRIBABLE_DECL_HPP