MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_CoalesceDropFactory_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#ifndef MUELU_COALESCEDROPFACTORY_DECL_HPP
47#define MUELU_COALESCEDROPFACTORY_DECL_HPP
48
49#include <Xpetra_Matrix_fwd.hpp>
50#include <Xpetra_MultiVector_fwd.hpp>
51#include <Xpetra_VectorFactory_fwd.hpp>
52#include <Xpetra_Vector_fwd.hpp>
53#include <Xpetra_ExportFactory_fwd.hpp>
54#include <Xpetra_ImportFactory_fwd.hpp>
55#include <Xpetra_MapFactory_fwd.hpp>
56#include <Xpetra_CrsGraph_fwd.hpp>
57#include <Xpetra_CrsGraphFactory.hpp> //TODO
58#include <Xpetra_StridedMap_fwd.hpp>
59#include <Xpetra_Map_fwd.hpp>
60
61#include "MueLu_ConfigDefs.hpp"
65
66#include "MueLu_Level_fwd.hpp"
67#include "MueLu_GraphBase.hpp"
68#include "MueLu_Graph_fwd.hpp"
69#include "MueLu_LWGraph_fwd.hpp"
74
75namespace MueLu {
76
132 template<class Scalar = DefaultScalar,
135 class Node = DefaultNode>
137#undef MUELU_COALESCEDROPFACTORY_SHORT
139
140 public:
141
143
144
147
150
151 RCP<const ParameterList> GetValidParameterList() const;
152
154
156
157
158 void DeclareInput(Level &currentLevel) const;
159
162
164
165 void Build(Level &currentLevel) const; // Build
166
167 private:
168
169 // pre-drop function
170 mutable
171 RCP<PreDropFunctionBaseClass> predrop_;
172
174 void MergeRows(const Matrix& A, const LO row, Array<LO>& cols, const Array<LO>& translation) const;
175 void MergeRowsWithDropping(const Matrix& A, const LO row, const ArrayRCP<const SC>& ghostedDiagVals, SC threshold, Array<LO>& cols, const Array<LO>& translation) const;
176
177
178 // When we want to decouple a block diagonal system (returns Teuchos::null if generate_matrix is false)
179 Teuchos::RCP<Xpetra::Matrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> > BlockDiagonalize(Level & currentLevel,const RCP<Matrix> & A, bool generate_matrix) const;
180
181 // When we want to decouple a block diagonal system via a *graph*
182 void BlockDiagonalizeGraph(const RCP<GraphBase> & inputGraph, const RCP<LocalOrdinalVector> & ghostedBlockNumber, RCP<GraphBase> & outputGraph, RCP<const Import> & importer) const;
183
184 }; //class CoalesceDropFactory
185
186} //namespace MueLu
187
188#define MUELU_COALESCEDROPFACTORY_SHORT
189#endif // MUELU_COALESCEDROPFACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Factory for creating a graph based on a given matrix.
void MergeRows(const Matrix &A, const LO row, Array< LO > &cols, const Array< LO > &translation) const
Method to merge rows of matrix for systems of PDEs.
Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > BlockDiagonalize(Level &currentLevel, const RCP< Matrix > &A, bool generate_matrix) const
void DeclareInput(Level &currentLevel) const
Input.
void MergeRowsWithDropping(const Matrix &A, const LO row, const ArrayRCP< const SC > &ghostedDiagVals, SC threshold, Array< LO > &cols, const Array< LO > &translation) const
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void Build(Level &currentLevel) const
Build an object with this factory.
void SetPreDropFunction(const RCP< MueLu::PreDropFunctionBaseClass< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &predrop)
set predrop function
void BlockDiagonalizeGraph(const RCP< GraphBase > &inputGraph, const RCP< LocalOrdinalVector > &ghostedBlockNumber, RCP< GraphBase > &outputGraph, RCP< const Import > &importer) const
RCP< PreDropFunctionBaseClass > predrop_
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Base class for factories that use one level (currentLevel).
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar