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  * MueLu_CoarseMapFactory_decl.hpp
48  *
49  * Created on: Oct 12, 2012
50  * Author: wiesner
51  */
52 
53 #ifndef MUELU_COARSEMAPFACTORY_DECL_HPP_
54 #define MUELU_COARSEMAPFACTORY_DECL_HPP_
55 
57 
58 #include "MueLu_ConfigDefs.hpp"
61 
62 #include "MueLu_Level_fwd.hpp"
63 #include "MueLu_Aggregates_fwd.hpp"
64 #include "MueLu_Exceptions.hpp"
65 
66 namespace MueLu {
67 
113  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
115 #undef MUELU_COARSEMAPFACTORY_SHORT
116 #include "MueLu_UseShortNames.hpp"
117 
118  public:
119 
121 
122 
125 
127  virtual ~CoarseMapFactory();
128 
130 
132 
134 
135 
141  void DeclareInput(Level &currentLevel) const;
142 
144 
146 
147 
149  void Build(Level &currentLevel) const;
150 
152 
153 
159  virtual size_t getFixedBlockSize() const {
160  // sum up size of all strided blocks (= number of dofs per node)
161  size_t blkSize = 0;
162  std::vector<size_t>::const_iterator it;
163  for(it = stridingInfo_.begin(); it != stridingInfo_.end(); ++it) {
164  blkSize += *it;
165  }
166  return blkSize;
167  }
168 
170 
175  virtual std::vector<size_t> getStridingData() const { return stridingInfo_; }
176 
181  virtual void setStridingData(std::vector<size_t> stridingInfo);
182 
187  virtual LocalOrdinal getStridedBlockId() const {
188  const ParameterList & pL = GetParameterList();
189  return pL.get<LocalOrdinal>("Strided block id");
190  }
191 
196  virtual void setStridedBlockId(LocalOrdinal stridedBlockId) {
197  SetParameter("Strided block id", ParameterEntry(stridedBlockId));
198  }
199 
201 
202  protected:
203 
204  mutable std::vector<size_t> stridingInfo_; // vector with size of strided blocks (dofs)
205  //LocalOrdinal stridedBlockId_; // member variable denoting which dofs are stored in map
206  // stridedBlock == -1: the full map (with all strided block dofs)
207  // stridedBlock > -1: only dofs of strided block with index "stridedBlockId" are stored in this map
208 
209 
210  }; //class CoarseMapFactory
211 
212 } //namespace MueLu
213 
214 #define MUELU_COARSEMAPFACTORY_SHORT
215 #endif /* MUELU_COARSEMAPFACTORY_DECL_HPP_ */
virtual const Teuchos::ParameterList & GetParameterList() const
Factory for generating coarse level map. Used by TentativePFactory.
T & get(const std::string &name, T def_value)
void Build(Level &currentLevel) const
Build an object with this factory.
virtual ~CoarseMapFactory()
Destructor.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void DeclareInput(Level &currentLevel) const
Specifies the data that this class needs, and the factories that generate that data.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
void SetParameter(const std::string &name, const ParameterEntry &entry)
Set a parameter directly as a ParameterEntry.
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
getFixedBlockSize returns the full block size (number of DOFs per node) of the domain DOF map (= coar...
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...