MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_Describable.cpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // MueLu: A package for multigrid based preconditioning
6 // Copyright 2012 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact
39 // Jonathan Hu (jhu@sandia.gov)
40 // Andrey Prokopenko (aprokop@sandia.gov)
41 // Ray Tuminaro (rstumin@sandia.gov)
42 //
43 // ***********************************************************************
44 //
45 // @HEADER
46 #ifndef MUELU_DESCRIBABLE_HPP
47 #define MUELU_DESCRIBABLE_HPP
48 
49 #include "MueLu_Describable.hpp"
50 
51 namespace MueLu {
52 
54 
55  void Describable::describe(Teuchos::FancyOStream &out_arg, const VerbLevel /* verbLevel */) const {
56  Teuchos::RCP<Teuchos::FancyOStream> out = rcp(&out_arg,false); //JG: no idea why we have to do that, but it's how Teuchos::Describable::describe() is implemented
57  Teuchos::OSTab tab(out);
58  *out << this->description() << std::endl;
59  }
60 
61  std::string Describable::description() const {
62  std::string str = Teuchos::Describable::description();
63 
64  // remove template parameters
65  size_t found = str.find_first_of("<");
66  if (found != std::string::npos)
67  return str.substr(0, found);
68 
69  return str;
70  }
71 
72  void Describable::describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const { describe(out, toMueLuVerbLevel(verbLevel)); }
73 
74  std::string Describable::ShortClassName() const {
75  if ( shortClassName_.empty() )
76  {
77  std::string str = Teuchos::Describable::description();
78 
79  // remove template parameters
80  {
81  size_t found = str.find_first_of("<");
82  if (found != std::string::npos)
83  str = str.substr(0, found);
84  }
85 
86  // remove namespace
87  {
88  size_t found = str.find_last_of(":");
89  if (found != std::string::npos)
90  str = str.substr(found+1);
91  }
92  shortClassName_ = str;
93  }
94  return shortClassName_;
95  }
96 
97 } // namespace MueLu
98 
99 #define MUELU_DESCRIBABLE_SHORT
100 #endif // MUELU_DESCRIBABLE_HPP
virtual void describe(Teuchos::FancyOStream &out_arg, const VerbLevel verbLevel=Default) const
VerbLevel toMueLuVerbLevel(const Teuchos::EVerbosityLevel verbLevel)
virtual std::string ShortClassName() const
Return the class name of the object, without template parameters and without namespace.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
virtual std::string description() const
virtual ~Describable()
Destructor.
virtual std::string description() const
Return a simple one-line description of this object.