MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_NullspaceFactory_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_NULLSPACEFACTORY_DECL_HPP
47#define MUELU_NULLSPACEFACTORY_DECL_HPP
48
49#include <Xpetra_Matrix_fwd.hpp>
50#include <Xpetra_VectorFactory_fwd.hpp>
51#include <Xpetra_MultiVectorFactory_fwd.hpp>
52
53#include "MueLu_ConfigDefs.hpp"
56
57#include "MueLu_Level_fwd.hpp"
58
59namespace MueLu {
60
105template <class Scalar = DefaultScalar,
108 class Node = DefaultNode>
110#undef MUELU_NULLSPACEFACTORY_SHORT
112
113 public:
114
116
117
119 NullspaceFactory(const std::string & nspName = "Nullspace") {
120 SetParameter("Fine level nullspace", ParameterEntry(nspName));
121 }
122
124 virtual ~NullspaceFactory() { }
125
127
129
131
133 RCP<const ParameterList> GetValidParameterList() const;
134
141 void DeclareInput(Level &currentLevel) const;
142
144
146
147
149 void Build(Level &currentLevel) const;
150
152
153 private:
155 void fillNullspaceVector(const RCP<BlockedMultiVector>& nsp, LocalOrdinal numPDEs, ArrayRCP<const typename Teuchos::ScalarTraits<Scalar>::coordinateType> xvals, ArrayRCP<const typename Teuchos::ScalarTraits<Scalar>::coordinateType> yvals, ArrayRCP<const typename Teuchos::ScalarTraits<Scalar>::coordinateType> zvals, LocalOrdinal nullspaceDim, Scalar cx, Scalar cy, Scalar cz) const;
156
157 mutable bool calculateRotations_ = false;
158
159 }; //class NullspaceFactory
160
161} //namespace MueLu
162
163#define MUELU_NULLSPACEFACTORY_SHORT
164#endif // MUELU_NULLSPACEFACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Class that holds all level-specific information.
Factory for generating nullspace.
void Build(Level &currentLevel) const
Build an object with this factory.
void fillNullspaceVector(const RCP< BlockedMultiVector > &nsp, LocalOrdinal numPDEs, ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > xvals, ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > yvals, ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > zvals, LocalOrdinal nullspaceDim, Scalar cx, Scalar cy, Scalar cz) const
Helper function to recursively fill BlockedMultiVector with default null space vectors.
NullspaceFactory(const std::string &nspName="Nullspace")
Constructor.
RCP< const ParameterList > GetValidParameterList() const
Define valid parameters for internal factory parameters.
void DeclareInput(Level &currentLevel) const
Specifies the data that this class needs, and the factories that generate that data.
void SetParameter(const std::string &name, const ParameterEntry &entry)
Set a parameter directly as a ParameterEntry.
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