MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_RegionRFactory_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#ifndef MUELU_REGIONRFACTORY_DECL_HPP
48#define MUELU_REGIONRFACTORY_DECL_HPP
49
50#include "MueLu_ConfigDefs.hpp"
51
54
55namespace MueLu {
56
62 template <class Scalar = DefaultScalar,
65 class Node = DefaultNode>
67#undef MUELU_REGIONRFACTORY_SHORT
69
70 public:
71 using real_type = typename Teuchos::ScalarTraits<SC>::coordinateType;
72 using realvaluedmultivector_type = typename Xpetra::MultiVector<real_type, LO, GO, NO>;
73
75
76
78 RegionRFactory() = default;
79
81 virtual ~RegionRFactory() = default;
83
85
86 RCP<const ParameterList> GetValidParameterList() const;
87
88 void DeclareInput(Level& fineLevel, Level& coarseLevel) const;
89
91
93
94
95 void Build(Level& fineLevel, Level& coarseLevel) const;
96
97 void Build3D(const int numDimensions,
98 Array<LO>& lFineNodesPerDim,
99 const RCP<Matrix>& A,
100 const RCP<realvaluedmultivector_type>& fineCoordinates,
101 RCP<Matrix>& R,
102 RCP<realvaluedmultivector_type>& coarseCoordinates,
103 Array<LO>& lCoarseNodesPerDim) const;
104
106
107 }; // class RegionRFactory
108
109} // namespace MueLu
110
111#define MUELU_REGIONRFACTORY_SHORT
112#endif // MUELU_REGIONRFACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Class that holds all level-specific information.
Factory that builds a restriction operator for region multigrid.
void Build3D(const int numDimensions, Array< LO > &lFineNodesPerDim, const RCP< Matrix > &A, const RCP< realvaluedmultivector_type > &fineCoordinates, RCP< Matrix > &R, RCP< realvaluedmultivector_type > &coarseCoordinates, Array< LO > &lCoarseNodesPerDim) const
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
typename Teuchos::ScalarTraits< SC >::coordinateType real_type
RCP< const ParameterList > GetValidParameterList() const
Input.
virtual ~RegionRFactory()=default
Destructor.
RegionRFactory()=default
Default Constructor.
typename Xpetra::MultiVector< real_type, LO, GO, NO > realvaluedmultivector_type
Base class for factories that use two levels (fineLevel and coarseLevel).
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar