MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_NoFactory.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_NOFACTORY_HPP
47#define MUELU_NOFACTORY_HPP
48
49#include <algorithm> // for swap
50#include "Teuchos_RCPDecl.hpp" // for RCP
51#include "Teuchos_RCP.hpp" // for RCP::RCP<T>, RCP::operator=, etc
52#include "MueLu_config.hpp" // for HAVE_MUELU_DEBUG
53#include "MueLu_Exceptions.hpp"
54#include "MueLu_FactoryBase.hpp"
55#include "MueLu_Level_fwd.hpp"
56
57namespace MueLu {
58
65 class NoFactory : public FactoryBase {
66
69
70 public:
71
73 virtual ~NoFactory() { }
74
76
77
79 void CallBuild(Level& requestedLevel) const;
80
82 void CallDeclareInput(Level& /* requestedLevel */) const { }
83
85
87
88
90 static const RCP<const NoFactory> getRCP() {
91 if (noFactory_.is_null())
92 noFactory_ = rcp(new NoFactory());
93
94 return noFactory_;
95 }
96
98 static const NoFactory* get();
99
101#ifdef HAVE_MUELU_DEBUG
102 void ResetDebugData() const { }
103#endif
104
105 private:
106 static RCP<const NoFactory> noFactory_; // static NoFactory instance for user defined "factories"
107
108 }; // class NoFactory
109
110} // namespace MueLu
111
112#endif // MUELU_NOFACTORY_HPP
Base class for factories (e.g., R, P, and A_coarse).
Class that holds all level-specific information.
NoFactory that is used for data stored in level class for that no generating factory is available/nec...
static RCP< const NoFactory > noFactory_
virtual ~NoFactory()
Destructor.
NoFactory()
Constructor.
void CallBuild(Level &requestedLevel) const
Implementation of FactoryBase interface.
static const RCP< const NoFactory > getRCP()
Static Get() functions.
void CallDeclareInput(Level &) const
static const NoFactory * get()
Namespace for MueLu classes and methods.