MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_MultiVectorTransferFactory_def.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_MULTIVECTORTRANSFER_FACTORY_DEF_HPP
47#define MUELU_MULTIVECTORTRANSFER_FACTORY_DEF_HPP
48
50#include "Xpetra_MultiVectorFactory.hpp"
51
52#include "MueLu_Level.hpp"
53#include "MueLu_Monitor.hpp"
54
55namespace MueLu {
56
57 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
59 RCP<ParameterList> validParamList = rcp(new ParameterList());
60
61 validParamList->set< std::string > ("Vector name", "undefined", "Name of the vector that will be transferred on the coarse grid (level key)"); // TODO: how to set a validator without default value?
62 validParamList->set< RCP<const FactoryBase> >("Vector factory", Teuchos::null, "Factory of the vector");
63 validParamList->set< RCP<const FactoryBase> >("R", Teuchos::null, "Factory of the transfer operator (restriction)");
64
65 return validParamList;
66 }
67
68 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
70 SetParameter("Vector name", ParameterEntry(vectorName));
71 }
72
73 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
75 const ParameterList & pL = GetParameterList();
76 std::string vectorName = pL.get<std::string>("Vector name");
77
78 fineLevel.DeclareInput(vectorName, GetFactory("Vector factory").get(), this);
79 Input(coarseLevel, "R");
80 }
81
82 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
84 FactoryMonitor m(*this, "Build", coarseLevel);
85
86 const ParameterList & pL = GetParameterList();
87 std::string vectorName = pL.get<std::string>("Vector name");
88
89 RCP<MultiVector> fineVector = fineLevel.Get< RCP<MultiVector> >(vectorName, GetFactory("Vector factory").get());
90 RCP<Matrix> transferOp = Get<RCP<Matrix> >(coarseLevel, "R");
91
92 RCP<MultiVector> coarseVector = MultiVectorFactory::Build(transferOp->getRangeMap(), fineVector->getNumVectors());
93 GetOStream(Runtime0) << "Transferring multivector \"" << vectorName << "\"" << std::endl;
94
95 RCP<MultiVector> onesVector = MultiVectorFactory::Build(transferOp->getDomainMap(), 1);
96 onesVector->putScalar(Teuchos::ScalarTraits<Scalar>::one());
97 RCP<MultiVector> rowSumVector = MultiVectorFactory::Build(transferOp->getRangeMap(), 1);
98 transferOp->apply(*onesVector, *rowSumVector);
99 transferOp->apply(*fineVector, *coarseVector);
100
101 if (vectorName == "Coordinates")
102 TEUCHOS_TEST_FOR_EXCEPTION(true,Exceptions::RuntimeError,"Use CoordinatesTransferFactory to transfer coordinates instead of MultiVectorTransferFactory.");
103
104 Set<RCP<MultiVector> >(coarseLevel, vectorName, coarseVector);
105
106 } // Build
107
108 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
110 if (blksize == 1)
111 return coordinates;
112
113 ArrayRCP<SC> expandCoord(coordinates.size()*blksize); //TODO: how to avoid automatic initialization of the vector? using arcp()?
114
115 for(int i=0; i<coordinates.size(); i++) {
116 for(int j=0; j< blksize; j++) {
117 expandCoord[i*blksize + j] = coordinates[i];
118 }
119 }
120 return expandCoord;
121
122 } // expandCoordinates
123
124} // namespace MueLu
125
126#endif // MUELU_MULTIVECTORTRANSFER_FACTORY_DEF_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
Exception throws to report errors in the internal logical of the program.
Timer to be used in factories. Similar to Monitor but with additional timers.
Class that holds all level-specific information.
void DeclareInput(const std::string &ename, const FactoryBase *factory, const FactoryBase *requestedBy=NoFactory::get())
Callback from FactoryBase::CallDeclareInput() and FactoryBase::DeclareInput()
T & Get(const std::string &ename, const FactoryBase *factory=NoFactory::get())
Get data without decrementing associated storage counter (i.e., read-only access)....
void DeclareInput(Level &finelevel, Level &coarseLevel) const
Specifies the data that this class needs, and the factories that generate that data.
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
static ArrayRCP< SC > expandCoordinates(ArrayRCP< SC > coord, LocalOrdinal blksize)
Namespace for MueLu classes and methods.
@ Runtime0
One-liner description of what is happening.