MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_PFactory_decl.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_PFACTORY_DEF_HPP
47#define MUELU_PFACTORY_DEF_HPP
48
49#include "MueLu_ConfigDefs.hpp"
52
53#include "MueLu_Level_fwd.hpp"
54
55namespace MueLu {
56
65
66 protected:
67
68 bool restrictionMode_; //< true, if PFactory is used for generating the restriction operator
69
70 public:
72
73
76
78 virtual ~PFactory() {}
80
82
83
87 virtual void BuildP(Level &fineLevel, Level &coarseLevel) const = 0;
89
90
92
93
96 void setRestrictionMode(bool bRestrictionMode = false) {
97 restrictionMode_ = bRestrictionMode;
98 }
99
102
104
105 }; //class PFactory
106
107} //namespace MueLu
108
109#define MUELU_PFACTORY_SHORT
110#endif // MUELU_PFACTORY_DEF_HPP
Class that holds all level-specific information.
Factory that provides an interface for a concrete implementation of a prolongation operator.
virtual ~PFactory()
Destructor.
bool isRestrictionModeSet()
returns restrictionMode flag
void setRestrictionMode(bool bRestrictionMode=false)
virtual void BuildP(Level &fineLevel, Level &coarseLevel) const =0
Abstract Build method.
Base class for factories that use two levels (fineLevel and coarseLevel).
Namespace for MueLu classes and methods.