MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_FactoryBase.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_FACTORYBASE_HPP
47#define MUELU_FACTORYBASE_HPP
48
49#include "MueLu_config.hpp"
50#include "MueLu_BaseClass.hpp"
51#include "MueLu_Level_fwd.hpp"
52
53namespace MueLu {
54
60 class FactoryBase : public virtual BaseClass {
61
62 public:
64
69
71 virtual ~FactoryBase() { }
73
75
76
77 virtual void CallBuild(Level & requestedLevel) const = 0;
78
79 virtual void CallDeclareInput(Level & requestedLevel) const = 0;
81
83
84
86 int GetID() const { return id_; };
87
89
90#ifdef HAVE_MUELU_DEBUG
91 virtual void ResetDebugData() const = 0;
92#endif
93
94 private:
95
96 static int GenerateUniqueId();
97
98 const int id_;
99
100 }; //class FactoryBase
101
102} //namespace MueLu
103
104#define MUELU_FACTORYBASE_SHORT
105#endif //ifndef MUELU_FACTORYBASE_HPP
Base class for MueLu classes.
Base class for factories (e.g., R, P, and A_coarse).
static int GenerateUniqueId()
virtual void CallBuild(Level &requestedLevel) const =0
virtual void CallDeclareInput(Level &requestedLevel) const =0
int GetID() const
return unique factory id
virtual ~FactoryBase()
Destructor.
Class that holds all level-specific information.
Namespace for MueLu classes and methods.