MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_StructuredAggregationFactory_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_STRUCTUREDAGGREGATIONFACTORY_DECL_HPP
47#define MUELU_STRUCTUREDAGGREGATIONFACTORY_DECL_HPP
48
49
50// #include <Xpetra_Map_fwd.hpp>
51// #include <Xpetra_CrsGraph_fwd.hpp>
52// #include <Xpetra_CrsGraphFactory.hpp>
53
54#include "MueLu_ConfigDefs.hpp"
57#include "MueLu_Level_fwd.hpp"
58#include "MueLu_Exceptions.hpp"
60
61namespace MueLu {
62
105 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
107#undef MUELU_STRUCTUREDAGGREGATIONFACTORY_SHORT
109
110 public:
112
113
116
119
120 RCP<const ParameterList> GetValidParameterList() const;
121
123
125
126 // set information about 1-node aggregates (map name and generating factory)
127 void SetOnePtMapName(const std::string name, Teuchos::RCP<const FactoryBase> mapFact) {
128 SetParameter("OnePt aggregate map name", ParameterEntry(std::string(name))); // revalidate
129 SetFactory("OnePt aggregate map factory",mapFact);
130 }
131
133
135
136
137 void DeclareInput(Level& currentLevel) const;
138
140
142
143
145 void Build(Level& currentLevel) const;
146
148
149 private:
150
154 mutable bool bDefinitionPhase_;
155
156 }; // class StructuredAggregationFactory
157
158}
159
160#define MUELU_STRUCTUREDAGGREGATIONFACTORY_SHORT
161#endif /* MUELU_STRUCTUREDAGGREGATIONFACTORY_DECL_HPP */
virtual void SetFactory(const std::string &varName, const RCP< const FactoryBase > &factory)
Configuration.
Class that holds all level-specific information.
void SetParameter(const std::string &name, const ParameterEntry &entry)
Set a parameter directly as a ParameterEntry.
Base class for factories that use one level (currentLevel).
Factory for building aggregates on structured grids.
void SetOnePtMapName(const std::string name, Teuchos::RCP< const FactoryBase > mapFact)
void Build(Level &currentLevel) const
Build aggregates.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Namespace for MueLu classes and methods.