MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_BaseClass.hpp
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_BASECLASS_HPP
47#define MUELU_BASECLASS_HPP
48
49#include "MueLu_ConfigDefs.hpp"
51#include "MueLu_Describable.hpp"
52
53namespace MueLu {
54
62 : public VerboseObject, public Describable
63 {
64
65 public:
66
68
69
71 virtual ~BaseClass() {}
72
74
75 }; // class BaseClass
76
77} // namespace MueLu
78
80// This macro defines ostream out0 that print only on root node. It print description() and indent the ostream.
81// Note: Runtime1 displays basic parameter information when Parameters0 is not enabled.
82#define MUELU_DESCRIBE \
83 using std::endl; \
84 Teuchos::FancyOStream& out0 = (VerboseObject::GetProcRankVerbose() == 0) ? out : VerboseObject::GetBlackHole(); \
85 \
86 if ((verbLevel & Runtime1) && (!(verbLevel & Parameters0))) \
87 out << description() << std::endl; \
88 else if (verbLevel & Runtime0) \
89 out << BaseClass::description() << std::endl; \
90 \
91 Teuchos::OSTab tab1(out); \
92 //
93
94#define MUELU_BASECLASS_SHORT
95#endif // ifndef MUELU_BASECLASS_HPP
Base class for MueLu classes.
virtual ~BaseClass()
Destructor.
Base class for MueLu classes.
Verbose class for MueLu classes.
Namespace for MueLu classes and methods.