MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_HierarchyFactory.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_HIERARCHYFACTORY_HPP
47#define MUELU_HIERARCHYFACTORY_HPP
48
49#include "Teuchos_RCP.hpp"
50
51#include "MueLu_ConfigDefs.hpp"
52#include "MueLu_BaseClass.hpp"
53
55
56namespace MueLu {
57
59 template <class Scalar = DefaultScalar,
62 class Node = DefaultNode>
63 class HierarchyFactory : public BaseClass {
64#undef MUELU_HIERARCHYFACTORY_SHORT
66
67 public:
69
71 virtual ~HierarchyFactory() { }
72
74
76 // Note: This function is not very useful at the moment as MueLu only have on Hierarchy class.
77 // In the future, we might have an abstract Hierarchy class and several derived Hierarchy classes.
78 // Using this function will then be the recommended way to generate a Hierarchy.
79 //
80 // This method is called Create() instead of Build(), because it return an non-initialized
81 // object (ie: MG setup is not done).
82 // Build() function in MueLu returns initialized objects.
83 virtual RCP<Hierarchy> CreateHierarchy() const = 0;
84
86 virtual RCP<Hierarchy> CreateHierarchy(const std::string& label) const = 0;
87
89 virtual void SetupHierarchy(Hierarchy & H) const = 0;
90
91 }; // class HierarchyFactoryBase
92
93} // namespace MueLu
94
95#define MUELU_HIERARCHYFACTORY_SHORT
96#endif //ifndef MUELU_HIERARCHYFACTORY_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Base class for MueLu classes.
virtual void SetupHierarchy(Hierarchy &H) const =0
Setup Hierarchy object.
virtual RCP< Hierarchy > CreateHierarchy() const =0
Create an empty Hierarchy object.
virtual RCP< Hierarchy > CreateHierarchy(const std::string &label) const =0
Create a labeled empty Hierarchy object.
virtual ~HierarchyFactory()
Destructor.
Provides methods to build a multigrid hierarchy and apply multigrid cycles.
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar