MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_SubBlockAFactory_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
47#ifndef MUELU_SUBBLOCKAFACTORY_DECL_HPP_
48#define MUELU_SUBBLOCKAFACTORY_DECL_HPP_
49
50#include <Xpetra_Map_fwd.hpp>
51#include <Xpetra_MapExtractor_fwd.hpp>
52#include <Xpetra_StridedMap_fwd.hpp>
53#include <Xpetra_StridedMapFactory_fwd.hpp>
54
55#include "MueLu_ConfigDefs.hpp"
58
59
60namespace MueLu {
61
91 template <class Scalar = DefaultScalar,
94 class Node = DefaultNode>
96#undef MUELU_SUBBLOCKAFACTORY_SHORT
98
99 public:
101
102
104 SubBlockAFactory() = default;
105
107 virtual ~SubBlockAFactory() = default;
109
111
112
113 RCP<const ParameterList> GetValidParameterList() const override;
114
115 void DeclareInput(Level &currentLevel) const override;
116
118
120
121
138 void Build(Level & currentLevel) const override;
139
141
142 private:
143 bool CheckForUserSpecifiedBlockInfo(bool bRange, std::vector<size_t>& stridingInfo, LocalOrdinal& stridedBlockId) const;
144
145 }; // class SubBlockAFactory
146
147} // namespace MueLu
148
149#define MUELU_SUBBLOCKAFACTORY_SHORT
150#endif /* MUELU_SUBBLOCKAFACTORY_DECL_HPP_ */
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Base class for factories that use one level (currentLevel).
Factory for building a thresholded operator.
void DeclareInput(Level &currentLevel) const override
Specifies the data that this class needs, and the factories that generate that data.
bool CheckForUserSpecifiedBlockInfo(bool bRange, std::vector< size_t > &stridingInfo, LocalOrdinal &stridedBlockId) const
void Build(Level &currentLevel) const override
Build an object with this factory.
virtual ~SubBlockAFactory()=default
Destructor.
SubBlockAFactory()=default
Constructor.
RCP< const ParameterList > GetValidParameterList() const override
Input.
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar