MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_Graph_def.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_GRAPH_DEF_HPP
47#define MUELU_GRAPH_DEF_HPP
48
49#include "MueLu_Graph_decl.hpp"
50#include "MueLu_Exceptions.hpp"
51
52namespace MueLu {
53
54#ifdef MUELU_UNUSED
55 template <class LocalOrdinal, class GlobalOrdinal, class Node>
56 size_t Graph<LocalOrdinal, GlobalOrdinal, Node>::GetNodeNumGhost() const {
57 /*
58 Ray's comments about nGhost:
59 Graph->NGhost == graph_->RowMatrixColMap()->NumMyElements() - graph_->MatrixDomainMap()->NumMyElements()
60 is basically right. But we've had some issues about how epetra handles empty columns.
61 Probably worth discussing this with Jonathan and Chris to see if this is ALWAYS right.
62 */
63 size_t nGhost = graph_->getColMap()->getLocalNumElements() - graph_->getDomainMap()->getLocalNumElements();
64 if (nGhost < 0) nGhost = 0; // FIXME: size_t is unsigned.
65
66 return nGhost;
67 }
68#endif
69
71 //using MueLu::Describable::describe; // overloading, not hiding
72 //void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const {
73 template <class LocalOrdinal, class GlobalOrdinal, class Node>
74 void Graph<LocalOrdinal, GlobalOrdinal, Node>::print(Teuchos::FancyOStream &out, const VerbLevel verbLevel) const {
76
77 if (verbLevel & Parameters0) {
78 //out0 << "Prec. type: " << type_ << std::endl;
79 }
80
81 if (verbLevel & Parameters1) {
82 //out0 << "Linear Algebra: " << toString(lib_) << std::endl;
83 //out0 << "PrecType: " << type_ << std::endl;
84 //out0 << "Parameter list: " << std::endl; { Teuchos::OSTab tab2(out); out << paramList_; }
85 //out0 << "Overlap: " << overlap_ << std::endl;
86 }
87
88 if (verbLevel & Debug) {
89 graph_->describe(out0, Teuchos::VERB_EXTREME);
90 }
91 }
92
93}
94
95#endif // MUELU_GRAPH_DEF_HPP
#define MUELU_DESCRIBE
Helper macro for implementing Describable::describe() for BaseClass objects.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the Graph with some verbosity level to an FancyOStream object.
Namespace for MueLu classes and methods.
@ Debug
Print additional debugging information.
@ Parameters0
Print class parameters.
@ Parameters1
Print class parameters (more parameters, more verbose)