MueLu
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
MueLu_Constraint_decl.hpp
Go to the documentation of this file.
1
// @HEADER
2
// *****************************************************************************
3
// MueLu: A package for multigrid based preconditioning
4
//
5
// Copyright 2012 NTESS and the MueLu contributors.
6
// SPDX-License-Identifier: BSD-3-Clause
7
// *****************************************************************************
8
// @HEADER
9
10
#ifndef MUELU_CONSTRAINT_DECL_HPP
11
#define MUELU_CONSTRAINT_DECL_HPP
12
13
#include <Teuchos_SerialDenseMatrix.hpp>
14
15
#include <Xpetra_MultiVector_fwd.hpp>
16
#include <Xpetra_Matrix_fwd.hpp>
17
#include <Xpetra_CrsGraph_fwd.hpp>
18
19
#include "
MueLu_ConfigDefs.hpp
"
20
#include "
MueLu_BaseClass.hpp
"
21
22
namespace
MueLu
{
23
25
64
65
template
<
class
Scalar
=
DefaultScalar
,
66
class
LocalOrdinal
=
DefaultLocalOrdinal
,
67
class
GlobalOrdinal
=
DefaultGlobalOrdinal
,
68
class
Node
=
DefaultNode
>
69
class
Constraint
:
public
BaseClass
{
70
#undef MUELU_CONSTRAINT_SHORT
71
#include "
MueLu_UseShortNames.hpp
"
72
public
:
77
78
using
MagnitudeType
=
typename
Teuchos::ScalarTraits<Scalar>::magnitudeType;
79
81
82
88
void
Setup
(
const
RCP<MultiVector>& B,
const
RCP<MultiVector>& Bc, RCP<const CrsGraph> Ppattern);
89
90
MagnitudeType
ResidualNorm
(
const
RCP<const Matrix> P)
const
;
91
93
95
96
98
void
Apply
(
const
Matrix& P, Matrix& Projected)
const
;
99
101
102
RCP<const CrsGraph>
GetPattern
()
const
{
103
return
Ppattern_
;
104
}
105
106
private
:
107
RCP<MultiVector>
B_
;
108
RCP<MultiVector>
Bc_
;
109
RCP<MultiVector>
X_
;
110
RCP<const CrsGraph>
Ppattern_
;
111
ArrayRCP<Teuchos::SerialDenseMatrix<LO, SC> >
XXtInv_
;
112
};
113
114
}
// namespace MueLu
115
116
#define MUELU_CONSTRAINT_SHORT
117
#endif
// MUELU_CONSTRAINT_DECL_HPP
MueLu_BaseClass.hpp
MueLu_ConfigDefs.hpp
LocalOrdinal
MueLu::DefaultLocalOrdinal LocalOrdinal
Definition
MueLu_UseDefaultTypes.hpp:13
Scalar
MueLu::DefaultScalar Scalar
Definition
MueLu_UseDefaultTypes.hpp:12
GlobalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Definition
MueLu_UseDefaultTypes.hpp:14
Node
MueLu::DefaultNode Node
Definition
MueLu_UseDefaultTypes.hpp:15
MueLu_UseShortNames.hpp
MueLu::BaseClass
Base class for MueLu classes.
Definition
MueLu_BaseClass.hpp:27
MueLu::Constraint
Constraint space information for the potential prolongator.
Definition
MueLu_Constraint_decl.hpp:69
MueLu::Constraint< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Bc_
RCP< MultiVector > Bc_
Definition
MueLu_Constraint_decl.hpp:108
MueLu::Constraint< Scalar, LocalOrdinal, GlobalOrdinal, Node >::XXtInv_
ArrayRCP< Teuchos::SerialDenseMatrix< LO, SC > > XXtInv_
Definition
MueLu_Constraint_decl.hpp:111
MueLu::Constraint< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Ppattern_
RCP< const CrsGraph > Ppattern_
Definition
MueLu_Constraint_decl.hpp:110
MueLu::Constraint::MagnitudeType
typename Teuchos::ScalarTraits< Scalar >::magnitudeType MagnitudeType
Definition
MueLu_Constraint_decl.hpp:78
MueLu::Constraint< Scalar, LocalOrdinal, GlobalOrdinal, Node >::X_
RCP< MultiVector > X_
Definition
MueLu_Constraint_decl.hpp:109
MueLu::Constraint::GetPattern
RCP< const CrsGraph > GetPattern() const
Definition
MueLu_Constraint_decl.hpp:102
MueLu::Constraint::Setup
void Setup(const RCP< MultiVector > &B, const RCP< MultiVector > &Bc, RCP< const CrsGraph > Ppattern)
Definition
MueLu_Constraint_def.hpp:33
MueLu::Constraint::Apply
void Apply(const Matrix &P, Matrix &Projected) const
Apply constraint.
Definition
MueLu_Constraint_def.hpp:120
MueLu::Constraint::ResidualNorm
MagnitudeType ResidualNorm(const RCP< const Matrix > P) const
Definition
MueLu_Constraint_def.hpp:103
MueLu::Constraint< Scalar, LocalOrdinal, GlobalOrdinal, Node >::B_
RCP< MultiVector > B_
Definition
MueLu_Constraint_decl.hpp:107
MueLu
Namespace for MueLu classes and methods.
Definition
MueLu_BrickAggregationFactory_decl.hpp:42
MueLu::DefaultNode
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Definition
MueLu_Details_DefaultTypes.hpp:32
MueLu::DefaultGlobalOrdinal
int DefaultGlobalOrdinal
Definition
MueLu_Details_DefaultTypes.hpp:29
MueLu::DefaultLocalOrdinal
int DefaultLocalOrdinal
Definition
MueLu_Details_DefaultTypes.hpp:22
MueLu::DefaultScalar
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar
Definition
MueLu_Details_DefaultTypes.hpp:20
src
Transfers
Energy-Minimization
MueLu_Constraint_decl.hpp
Generated by
1.17.0