MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_AmalgamationFactory_kokkos_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_AMALGAMATIONFACTORY_KOKKOS_DECL_HPP
47#define MUELU_AMALGAMATIONFACTORY_KOKKOS_DECL_HPP
48
49#include <Xpetra_Matrix_fwd.hpp>
50#include <Xpetra_Map_fwd.hpp>
51
52#include "MueLu_ConfigDefs.hpp"
54
55#include "MueLu_Level_fwd.hpp"
56#include "MueLu_Exceptions.hpp"
57
59
60namespace MueLu {
61
75 template<class Scalar = DefaultScalar,
78 class Node = DefaultNode>
80#undef MUELU_AMALGAMATIONFACTORY_KOKKOS_SHORT
82
83 public:
84
86
87
90
93
94 RCP<const ParameterList> GetValidParameterList() const;
95
97
99
100
101 void DeclareInput(Level &currentLevel) const;
102
104
105 void Build(Level &currentLevel) const; // Build
106
108 // @param gid (GlobalOrdinal): input global id (row gid or column gid)
109 // @param blockSize (LocalOrdinal): block size (needed for constant block size)
110 // @param offset (GlobalOrdinal): global offset for dofs (stored in strided map, default = 0)
111 // @param indexBase (GlobalOrdinal): indexBase for DOF map (and node map, default = 0)
112 static const GlobalOrdinal DOFGid2NodeId(GlobalOrdinal gid, LocalOrdinal blockSize, const GlobalOrdinal offset /*= 0*/, const GlobalOrdinal indexBase/* = 0*/);
113
115 // @param sourceMap (const Map&): source map with dofs which shall be amalgamated to a node map
116 // @param A (const Matrix&): operator A (matrix) with striding information (if available)
117 // @param amalgamatedMap (const Map&): amalgamated node based map
118 // @param translation (Array<LO>&): array storing local node ids given local dof ids (needed in CoalesceDropFactory)
119 static void AmalgamateMap(const Map& sourceMap, const Matrix& A, RCP<const Map>& amalgamatedMap, Array<LO>& translation); // const;
120
121
122 }; //class SubBlockUnAmalgamationFactory_kokkos
123
124} //namespace MueLu
125
126#define MUELU_AMALGAMATIONFACTORY_KOKKOS_SHORT
127#endif // MUELU_AMALGAMATIONFACTORY_KOKKOS_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
AmalgamationFactory_kokkos for subblocks of strided map based amalgamation data.
static const GlobalOrdinal DOFGid2NodeId(GlobalOrdinal gid, LocalOrdinal blockSize, const GlobalOrdinal offset, const GlobalOrdinal indexBase)
translate global (row/column) id to global amalgamation block id
static void AmalgamateMap(const Map &sourceMap, const Matrix &A, RCP< const Map > &amalgamatedMap, Array< LO > &translation)
Method to create merged map for systems of PDEs.
void DeclareInput(Level &currentLevel) const
Input.
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.
Class that holds all level-specific information.
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