MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_InitialBlockNumberFactory_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_INITIALBLOCKNUMBER_FACTORY_DEF_HPP
47#define MUELU_INITIALBLOCKNUMBER_FACTORY_DEF_HPP
48
49#include "Xpetra_VectorFactory.hpp"
50#include "Xpetra_Map.hpp"
51#include "Xpetra_Matrix.hpp"
52#include "Xpetra_IO.hpp"
53
55
56#include "MueLu_MasterList.hpp"
57#include "MueLu_Level.hpp"
58#include "MueLu_Monitor.hpp"
59
60namespace MueLu {
61
62 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
64 RCP<ParameterList> validParamList = rcp(new ParameterList());
65#define SET_VALID_ENTRY(name) validParamList->setEntry(name, MasterList::getEntry(name))
66 SET_VALID_ENTRY("aggregation: block diagonal: interleaved blocksize");
67#undef SET_VALID_ENTRY
68
69 validParamList->set< RCP<const FactoryBase> >("A", Teuchos::null, "Generating factory of the matrix A");
70
71 return validParamList;
72 }
73
74 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
76 Input(currentLevel, "A");
77 }
78
79 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
81 FactoryMonitor m(*this, "Build", currentLevel);
82 const ParameterList & pL = GetParameterList();
83
84 RCP<Matrix> A = Get< RCP<Matrix> >(currentLevel, "A");
85 LO blocksize = as<LO>(pL.get<int>("aggregation: block diagonal: interleaved blocksize"));
86
87 GetOStream(Statistics1) << "Generating interleaved blocking with "<<blocksize<<" equations"<<std::endl;
88 RCP<LocalOrdinalVector> BlockNumber = LocalOrdinalVectorFactory::Build(A->getRowMap(),false);
89 Teuchos::ArrayRCP<LO> bn_data = BlockNumber->getDataNonConst(0);
90 for(LO i=0; i<(LO)A->getRowMap()->getLocalNumElements();i++)
91 bn_data[i] = i % blocksize;
92
93 Set(currentLevel,"BlockNumber",BlockNumber);
94 }
95
96} // namespace MueLu
97
98#endif // MUELU_INITIALBLOCKNUMBER_FACTORY_DEF_HPP
#define SET_VALID_ENTRY(name)
Timer to be used in factories. Similar to Monitor but with additional timers.
void Build(Level &currentLevel) const
Build an object with this factory.
void DeclareInput(Level &currentLevel) const
Specifies the data that this class needs, and the factories that generate that data.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Class that holds all level-specific information.
Namespace for MueLu classes and methods.
@ Statistics1
Print more statistics.