MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_ToggleCoordinatesTransferFactory_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_TOGGLECOORDINATESTRANSFER_FACTORY_DECL_HPP
47#define MUELU_TOGGLECOORDINATESTRANSFER_FACTORY_DECL_HPP
48
49#include "MueLu_ConfigDefs.hpp"
51
53
54namespace MueLu {
55
61template <class Scalar = DefaultScalar,
64 class Node = DefaultNode>
66#undef MUELU_TOGGLECOORDINATESTRANSFERFACTORY_SHORT
68
69 public:
71
72
82
85
86 RCP<const ParameterList> GetValidParameterList() const;
87
89
91
92
98 void DeclareInput(Level &finelevel, Level &coarseLevel) const;
99
101
103
104
106 void Build(Level & fineLevel, Level &coarseLevel) const;
107
109
111
112
114 void AddCoordTransferFactory(const RCP<const FactoryBase>& factory);
115
117 size_t NumCoordTransferFactories() const { return coordFacts_.size(); }
119
120 private:
122 mutable std::vector<RCP<const FactoryBase> > coordFacts_;
123
124 mutable bool hasDeclaredInput_;
125 }; // class ToggleCoordinatesTransferFactory
126
127} // namespace MueLu
128
129#define MUELU_TOGGLECOORDINATESTRANSFERFACTORY_SHORT
130#endif // MUELU_TOGGLECOORDINATESTRANSFER_FACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Class that holds all level-specific information.
Class for transferring coordinates from a finer level to a coarser one.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void AddCoordTransferFactory(const RCP< const FactoryBase > &factory)
Add a coordinate transfer factory in the end of list of coordinate transfer factories.
size_t NumCoordTransferFactories() const
Returns number of coordinate transfer factories.
std::vector< RCP< const FactoryBase > > coordFacts_
list of user-defined transfer coordinate factories which provide coordinates on the coarse level!
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
void DeclareInput(Level &finelevel, Level &coarseLevel) const
Specifies the data that this class needs, and the factories that generate that data.
Base class for factories that use two levels (fineLevel and coarseLevel).
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar