MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_CoarseMapFactory_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_COARSEMAPFACTORY_DECL_HPP_
48 #define MUELU_COARSEMAPFACTORY_DECL_HPP_
49 
51 
52 #include "MueLu_ConfigDefs.hpp"
55 
56 #include "MueLu_Level_fwd.hpp"
57 #include "MueLu_Aggregates_fwd.hpp"
58 #include "MueLu_Exceptions.hpp"
59 
60 namespace MueLu {
61 
110 template <class Scalar = DefaultScalar,
113  class Node = DefaultNode>
115 #undef MUELU_COARSEMAPFACTORY_SHORT
116 #include "MueLu_UseShortNames.hpp"
117 
118  public:
120 
121 
123 
130  void DeclareInput(Level& currentLevel) const override;
131 
133 
135 
136 
138  void Build(Level& currentLevel) const override;
139 
141 
148  virtual size_t getFixedBlockSize() const {
149  // sum up size of all strided blocks (= number of dofs per node)
150  size_t blkSize = 0;
151  std::vector<size_t>::const_iterator it;
152  for (it = stridingInfo_.begin(); it != stridingInfo_.end(); ++it) {
153  blkSize += *it;
154  }
155  return blkSize;
156  }
157 
159 
164  virtual std::vector<size_t> getStridingData() const { return stridingInfo_; }
165 
170  virtual void setStridingData(std::vector<size_t> stridingInfo);
171 
176  virtual LocalOrdinal getStridedBlockId() const {
177  const ParameterList& pL = GetParameterList();
178  return pL.get<LocalOrdinal>("Strided block id");
179  }
180 
185  virtual void setStridedBlockId(LocalOrdinal stridedBlockId) {
186  SetParameter("Strided block id", ParameterEntry(stridedBlockId));
187  }
188 
190 
191  protected:
193  virtual void BuildCoarseMap(Level& currentLevel, const GlobalOrdinal domainGIDOffset) const;
194 
196  virtual GlobalOrdinal GetDomainGIDOffset(Level& currentLevel) const;
197 
198  private:
200  LocalOrdinal stridedBlockId, const size_t nullspaceDimension) const;
201 
203  mutable std::vector<size_t> stridingInfo_;
204 
205 }; // class CoarseMapFactory
206 
207 } // namespace MueLu
208 
209 #define MUELU_COARSEMAPFACTORY_SHORT
210 #endif /* MUELU_COARSEMAPFACTORY_DECL_HPP_ */
virtual const Teuchos::ParameterList & GetParameterList() const
MueLu::DefaultLocalOrdinal LocalOrdinal
Factory for generating coarse level map. Used by TentativePFactory.
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
T & get(const std::string &name, T def_value)
virtual void BuildCoarseMap(Level &currentLevel, const GlobalOrdinal domainGIDOffset) const
Build the coarse map using the domain GID offset.
RCP< const ParameterList > GetValidParameterList() const override
Return a const parameter list of valid parameters that setParameterList() will accept.
MueLu::DefaultNode Node
MueLu::DefaultScalar Scalar
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
virtual GlobalOrdinal GetDomainGIDOffset(Level &currentLevel) const
Extract domain GID offset from user data.
void SetParameter(const std::string &name, const ParameterEntry &entry)
Set a parameter directly as a ParameterEntry.
virtual void CheckForConsistentStridingInformation(LocalOrdinal stridedBlockId, const size_t nullspaceDimension) const
std::vector< size_t > stridingInfo_
Vector with size of strided blocks (dofs)
void Build(Level &currentLevel) const override
Build an object with this factory.
virtual LocalOrdinal getStridedBlockId() const
getStridedBlockId returns strided block id for the domain DOF map of Ptent (= coarse map) or -1 if fu...
virtual void setStridingData(std::vector< size_t > stridingInfo)
setStridingData set striding vector for the domain DOF map (= coarse map), e.g. (2,1) for 2 velocity dofs and 1 pressure dof
virtual size_t getFixedBlockSize() const
Get information on the fixed block size.
void DeclareInput(Level &currentLevel) const override
Specifies the data that this class needs, and the factories that generate that data.
virtual std::vector< size_t > getStridingData() const
getStridingData returns vector with size of striding blocks in the domain DOF map (= coarse map)...
Base class for factories that use one level (currentLevel).
virtual void setStridedBlockId(LocalOrdinal stridedBlockId)
setStridedBlockId set strided block id for the domain DOF map of Ptent (= coarse map) or -1 if full s...