Loading...
Searching...
No Matches
MueLu::UtilitiesBase< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference
#include <MueLu_UtilitiesBase_decl.hpp>
Inheritance diagram for MueLu::UtilitiesBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
Public Types | |
| typedef Teuchos::ScalarTraits< Scalar >::magnitudeType | Magnitude |
Static Public Member Functions | |
| static RCP< Matrix > | Crs2Op (RCP< CrsMatrix > Op) |
| static RCP< CrsMatrixWrap > | GetThresholdedMatrix (const RCP< Matrix > &Ain, const Scalar threshold, const bool keepDiagonal=true, const GlobalOrdinal expectedNNZperRow=-1) |
| Threshold a matrix. | |
| static RCP< Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > | GetThresholdedGraph (const RCP< Matrix > &A, const Magnitude threshold, const GlobalOrdinal expectedNNZperRow=-1) |
| Threshold a graph. | |
| static Teuchos::ArrayRCP< Scalar > | GetMatrixDiagonal_arcp (const Matrix &A) |
| Extract Matrix Diagonal. | |
| static RCP< Vector > | GetMatrixDiagonal (const Matrix &A) |
| Extract Matrix Diagonal. | |
| static RCP< Vector > | GetMatrixDiagonalInverse (const Matrix &A, Magnitude tol=Teuchos::ScalarTraits< Scalar >::eps() *100, Scalar valReplacement=Teuchos::ScalarTraits< Scalar >::zero(), const bool doLumped=false) |
| Extract Matrix Diagonal. | |
| static Teuchos::RCP< Vector > | GetLumpedMatrixDiagonal (Matrix const &A, const bool doReciprocal=false, Magnitude tol=Teuchos::ScalarTraits< Scalar >::magnitude(Teuchos::ScalarTraits< Scalar >::zero()), Scalar valReplacement=Teuchos::ScalarTraits< Scalar >::zero(), const bool replaceSingleEntryRowWithZero=false, const bool useAverageAbsDiagVal=false) |
| Extract Matrix Diagonal of lumped matrix. | |
| static Teuchos::ArrayRCP< Magnitude > | GetMatrixMaxMinusOffDiagonal (const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A) |
| Return vector containing: max_{i\not=k}(-a_ik), for each for i in the matrix. | |
| static Teuchos::ArrayRCP< Magnitude > | GetMatrixMaxMinusOffDiagonal (const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Xpetra::Vector< LocalOrdinal, LocalOrdinal, GlobalOrdinal, Node > &BlockNumber) |
| static Teuchos::RCP< Vector > | GetInverse (Teuchos::RCP< const Vector > v, Magnitude tol=Teuchos::ScalarTraits< Scalar >::eps() *100, Scalar valReplacement=Teuchos::ScalarTraits< Scalar >::zero()) |
| Return vector containing inverse of input vector. | |
| static RCP< Vector > | GetMatrixOverlappedDiagonal (const Matrix &A) |
| Extract Overlapped Matrix Diagonal. | |
| static RCP< Vector > | GetMatrixOverlappedDeletedRowsum (const Matrix &A) |
| Extract Overlapped Matrix Deleted Rowsum. | |
| static RCP< Xpetra::Vector< Magnitude, LocalOrdinal, GlobalOrdinal, Node > > | GetMatrixOverlappedAbsDeletedRowsum (const Matrix &A) |
| static Teuchos::Array< Magnitude > | ResidualNorm (const Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Op, const MultiVector &X, const MultiVector &RHS) |
| static Teuchos::Array< Magnitude > | ResidualNorm (const Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Op, const MultiVector &X, const MultiVector &RHS, MultiVector &Resid) |
| static RCP< MultiVector > | Residual (const Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Op, const MultiVector &X, const MultiVector &RHS) |
| static void | Residual (const Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Op, const MultiVector &X, const MultiVector &RHS, MultiVector &Resid) |
| static Scalar | PowerMethod (const Matrix &A, bool scaleByDiag=true, LocalOrdinal niters=10, Magnitude tolerance=1e-2, bool verbose=false, unsigned int seed=123) |
| Power method. | |
| static Scalar | PowerMethod (const Matrix &A, const RCP< Vector > &diagInvVec, LocalOrdinal niters=10, Magnitude tolerance=1e-2, bool verbose=false, unsigned int seed=123) |
| Power method. | |
| static RCP< Teuchos::FancyOStream > | MakeFancy (std::ostream &os) |
| static Teuchos::ScalarTraits< Scalar >::magnitudeType | Distance2 (const Teuchos::Array< Teuchos::ArrayRCP< const Scalar > > &v, LocalOrdinal i0, LocalOrdinal i1) |
| Squared distance between two rows in a multivector. | |
| static Teuchos::ScalarTraits< Scalar >::magnitudeType | Distance2 (const Teuchos::ArrayView< double > &weight, const Teuchos::Array< Teuchos::ArrayRCP< const Scalar > > &v, LocalOrdinal i0, LocalOrdinal i1) |
| Weighted squared distance between two rows in a multivector. | |
| static Teuchos::ArrayRCP< const bool > | DetectDirichletRows (const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Magnitude &tol=Teuchos::ScalarTraits< Magnitude >::zero(), bool count_twos_as_dirichlet=false) |
| Detect Dirichlet rows. | |
| static Kokkos::View< bool *, typename NO::device_type > | DetectDirichletRows_kokkos (const Matrix &A, const Magnitude &tol=Teuchos::ScalarTraits< typename Teuchos::ScalarTraits< SC >::magnitudeType >::zero(), const bool count_twos_as_dirichlet=false) |
| Detect Dirichlet rows. | |
| static Teuchos::ArrayRCP< const bool > | DetectDirichletRowsExt (const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, bool &bHasZeroDiagonal, const Magnitude &tol=Teuchos::ScalarTraits< Scalar >::zero()) |
| Detect Dirichlet rows (extended version). | |
| static void | FindNonZeros (const Teuchos::ArrayRCP< const Scalar > vals, Teuchos::ArrayRCP< bool > nonzeros) |
| Find non-zero values in an ArrayRCP Compares the value to 2 * machine epsilon. | |
| static void | FindNonZeros (const typename Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::dual_view_type::t_dev_const_um vals, Kokkos::View< bool *, typename Node::device_type > nonzeros) |
| Find non-zero values in an ArrayRCP Compares the value to 2 * machine epsilon. | |
| static void | DetectDirichletColsAndDomains (const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Teuchos::ArrayRCP< bool > &dirichletRows, Teuchos::ArrayRCP< bool > dirichletCols, Teuchos::ArrayRCP< bool > dirichletDomain) |
| Detects Dirichlet columns & domains from a list of Dirichlet rows. | |
| static void | DetectDirichletColsAndDomains (const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Kokkos::View< bool *, typename Node::device_type > &dirichletRows, Kokkos::View< bool *, typename Node::device_type > dirichletCols, Kokkos::View< bool *, typename Node::device_type > dirichletDomain) |
| Detects Dirichlet columns & domains from a list of Dirichlet rows. | |
| static void | ApplyRowSumCriterion (const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Magnitude rowSumTol, Teuchos::ArrayRCP< bool > &dirichletRows) |
| Apply Rowsum Criterion. | |
| static void | ApplyRowSumCriterion (const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Xpetra::Vector< LocalOrdinal, LocalOrdinal, GlobalOrdinal, Node > &BlockNumber, const Magnitude rowSumTol, Teuchos::ArrayRCP< bool > &dirichletRows) |
| static void | ApplyRowSumCriterion (const Matrix &A, const typename Teuchos::ScalarTraits< Scalar >::magnitudeType rowSumTol, Kokkos::View< bool *, typename NO::device_type > &dirichletRows) |
| static Teuchos::ArrayRCP< const bool > | DetectDirichletCols (const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Teuchos::ArrayRCP< const bool > &dirichletRows) |
| Detect Dirichlet columns based on Dirichlet rows. | |
| static Kokkos::View< bool *, typename NO::device_type > | DetectDirichletCols (const Matrix &A, const Kokkos::View< const bool *, typename NO::device_type > &dirichletRows) |
| Detect Dirichlet columns based on Dirichlet rows. | |
| static Scalar | Frobenius (const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B) |
| Frobenius inner product of two matrices. | |
| static void | SetRandomSeed (const Teuchos::Comm< int > &comm) |
| Set seed for random number generator. | |
| static void | FindDirichletRows (Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &A, std::vector< LocalOrdinal > &dirichletRows, bool count_twos_as_dirichlet=false) |
| static void | ApplyOAZToMatrixRows (Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &A, const std::vector< LocalOrdinal > &dirichletRows) |
| static void | ApplyOAZToMatrixRows (Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &A, const Teuchos::ArrayRCP< const bool > &dirichletRows) |
| static void | ApplyOAZToMatrixRows (RCP< Matrix > &A, const Kokkos::View< const bool *, typename Node::device_type > &dirichletRows) |
| static void | ZeroDirichletRows (Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &A, const std::vector< LocalOrdinal > &dirichletRows, Scalar replaceWith=Teuchos::ScalarTraits< Scalar >::zero()) |
| static void | ZeroDirichletRows (Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &A, const Teuchos::ArrayRCP< const bool > &dirichletRows, Scalar replaceWith=Teuchos::ScalarTraits< Scalar >::zero()) |
| static void | ZeroDirichletRows (Teuchos::RCP< Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &X, const Teuchos::ArrayRCP< const bool > &dirichletRows, Scalar replaceWith=Teuchos::ScalarTraits< Scalar >::zero()) |
| static void | ZeroDirichletRows (RCP< Matrix > &A, const Kokkos::View< const bool *, typename NO::device_type > &dirichletRows, SC replaceWith=Teuchos::ScalarTraits< SC >::zero()) |
| static void | ZeroDirichletRows (RCP< MultiVector > &X, const Kokkos::View< const bool *, typename NO::device_type > &dirichletRows, SC replaceWith=Teuchos::ScalarTraits< SC >::zero()) |
| static void | ZeroDirichletCols (Teuchos::RCP< Matrix > &A, const Teuchos::ArrayRCP< const bool > &dirichletCols, Scalar replaceWith=Teuchos::ScalarTraits< Scalar >::zero()) |
| static void | ZeroDirichletCols (RCP< Matrix > &A, const Kokkos::View< const bool *, typename NO::device_type > &dirichletCols, SC replaceWith=Teuchos::ScalarTraits< SC >::zero()) |
| static void | FindDirichletRowsAndPropagateToCols (Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &A, Teuchos::RCP< Xpetra::Vector< int, LocalOrdinal, GlobalOrdinal, Node > > &isDirichletRow, Teuchos::RCP< Xpetra::Vector< int, LocalOrdinal, GlobalOrdinal, Node > > &isDirichletCol) |
| static RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > | ReplaceNonZerosWithOnes (const RCP< Matrix > &original) |
| Creates a copy of a matrix where the non-zero entries are replaced by ones. | |
| static RCP< const Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node > > | GeneratedBlockedTargetMap (const Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node > &sourceBlockedMap, const Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &Importer) |
| static bool | MapsAreNested (const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &rowMap, const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &colMap) |
| static RCP< Xpetra::Vector< LocalOrdinal, LocalOrdinal, GlobalOrdinal, Node > > | CuthillMcKee (const Matrix &Op) |
| static RCP< Xpetra::Vector< LocalOrdinal, LocalOrdinal, GlobalOrdinal, Node > > | ReverseCuthillMcKee (const Matrix &Op) |
Detailed Description
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::UtilitiesBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >
class MueLu::UtilitiesBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >
MueLu utility class.
This class provides a number of static helper methods. Some are temporary and will eventually go away, while others should be moved to Xpetra.
Definition at line 99 of file MueLu_UtilitiesBase_decl.hpp.
Member Typedef Documentation
◆ Magnitude
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
| typedef Teuchos::ScalarTraits<Scalar>::magnitudeType MueLu::UtilitiesBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Magnitude |
Definition at line 104 of file MueLu_UtilitiesBase_decl.hpp.
Member Function Documentation
◆ Crs2Op()
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Definition at line 80 of file MueLu_UtilitiesBase_def.hpp.
◆ GetThresholdedMatrix()
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Threshold a matrix.
Returns matrix filtered with a threshold value.
NOTE – it's assumed that A has been fillComplete'd.
Definition at line 89 of file MueLu_UtilitiesBase_def.hpp.
◆ GetThresholdedGraph()
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Threshold a graph.
Returns graph filtered with a threshold value.
NOTE – it's assumed that A has been fillComplete'd.
Definition at line 141 of file MueLu_UtilitiesBase_def.hpp.
◆ GetMatrixDiagonal_arcp()
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Extract Matrix Diagonal.
Returns Matrix diagonal in ArrayRCP.
NOTE – it's assumed that A has been fillComplete'd.
Definition at line 177 of file MueLu_UtilitiesBase_def.hpp.
◆ GetMatrixDiagonal()
|
static |
Extract Matrix Diagonal.
Returns Matrix diagonal in RCP<Vector>.
NOTE – it's assumed that A has been fillComplete'd.
Definition at line 203 of file MueLu_UtilitiesBase_def.hpp.
◆ GetMatrixDiagonalInverse()
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Extract Matrix Diagonal.
Returns inverse of the Matrix diagonal in ArrayRCP.
NOTE – it's assumed that A has been fillComplete'd.
Definition at line 233 of file MueLu_UtilitiesBase_def.hpp.
◆ GetLumpedMatrixDiagonal()
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Extract Matrix Diagonal of lumped matrix.
Returns Matrix diagonal of lumped matrix in RCP<Vector>.
NOTE – it's assumed that A has been fillComplete'd.
Definition at line 322 of file MueLu_UtilitiesBase_def.hpp.
◆ GetMatrixMaxMinusOffDiagonal() [1/2]
|
static |
Return vector containing: max_{i\not=k}(-a_ik), for each for i in the matrix.
- Parameters
-
[in] A input matrix @ret: vector containing max_{i\not=k}(-a_ik)
Definition at line 500 of file MueLu_UtilitiesBase_def.hpp.
◆ GetMatrixMaxMinusOffDiagonal() [2/2]
|
static |
Definition at line 522 of file MueLu_UtilitiesBase_def.hpp.
◆ GetInverse()
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Return vector containing inverse of input vector.
- Parameters
-
[in] v input vector [in] tol tolerance. If entries of input vector are smaller than tolerance they are replaced by valReplacement (see below). The default value for tol is 100*eps (machine precision) [in] valReplacement Value put in for undefined entries in output vector (default: 0.0) @ret: vector containing inverse values of input vector v
Definition at line 551 of file MueLu_UtilitiesBase_def.hpp.
◆ GetMatrixOverlappedDiagonal()
|
static |
Extract Overlapped Matrix Diagonal.
Returns overlapped Matrix diagonal in ArrayRCP.
The local overlapped diagonal has an entry for each index in A's column map. NOTE – it's assumed that A has been fillComplete'd.
Definition at line 625 of file MueLu_UtilitiesBase_def.hpp.
◆ GetMatrixOverlappedDeletedRowsum()
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Extract Overlapped Matrix Deleted Rowsum.
Returns overlapped Matrix deleted Rowsum in ArrayRCP.
The local overlapped deleted Rowsum has an entry for each index in A's column map. NOTE – it's assumed that A has been fillComplete'd.
Definition at line 657 of file MueLu_UtilitiesBase_def.hpp.
◆ GetMatrixOverlappedAbsDeletedRowsum()
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Definition at line 699 of file MueLu_UtilitiesBase_def.hpp.
◆ ResidualNorm() [1/2]
|
static |
Definition at line 743 of file MueLu_UtilitiesBase_def.hpp.
◆ ResidualNorm() [2/2]
|
static |
Definition at line 755 of file MueLu_UtilitiesBase_def.hpp.
◆ Residual() [1/2]
|
static |
Definition at line 767 of file MueLu_UtilitiesBase_def.hpp.
◆ Residual() [2/2]
|
static |
Definition at line 780 of file MueLu_UtilitiesBase_def.hpp.
◆ PowerMethod() [1/2]
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Power method.
- Parameters
-
A matrix scaleByDiag if true, estimate the largest eigenvalue of \( D^; A \). niters maximum number of iterations tolerance stopping tolerance @verbose if true, print iteration information @seed seed for randomizing initial guess
(Shamelessly grabbed from tpetra/examples.)
◆ PowerMethod() [2/2]
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Power method.
- Parameters
-
A matrix diagInvVec reciprocal of matrix diagonal niters maximum number of iterations tolerance stopping tolerance @verbose if true, print iteration information @seed seed for randomizing initial guess
(Shamelessly grabbed from tpetra/examples.)
◆ MakeFancy()
|
static |
Definition at line 863 of file MueLu_UtilitiesBase_def.hpp.
◆ Distance2() [1/2]
|
static |
Squared distance between two rows in a multivector.
Used for coordinate vectors.
Definition at line 872 of file MueLu_UtilitiesBase_def.hpp.
◆ Distance2() [2/2]
|
static |
Weighted squared distance between two rows in a multivector.
Used for coordinate vectors.
Definition at line 886 of file MueLu_UtilitiesBase_def.hpp.
◆ DetectDirichletRows()
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Detect Dirichlet rows.
The routine assumes, that if there is only one nonzero per row, it is on the diagonal and therefore a DBC. This is safe for most of our applications, but one should be aware of that.
There is an alternative routine (see DetectDirichletRowsExt)
- Parameters
-
[in] A matrix [in] tol If a row entry's magnitude is less than or equal to this tolerance, the entry is treated as zero.
- Returns
- boolean array. The ith entry is true iff row i is a Dirichlet row.
Definition at line 901 of file MueLu_UtilitiesBase_def.hpp.
◆ DetectDirichletRows_kokkos()
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Detect Dirichlet rows.
- Parameters
-
[in] A matrix [in] tol If a row entry's magnitude is less than or equal to this tolerance, the entry is treated as zero.
- Returns
- boolean array. The ith entry is true iff row i is a Dirichlet row.
Definition at line 943 of file MueLu_UtilitiesBase_def.hpp.
◆ DetectDirichletRowsExt()
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Detect Dirichlet rows (extended version).
Look at each matrix row and mark it as Dirichlet if there is only one "not small" nonzero on the diagonal. In determining whether a nonzero is "not small" use \f abs(A(i,j)) / sqrt(abs(diag[i]*diag[j])) > tol
- Parameters
-
[in] A matrix [in/out] bHasZeroDiagonal Reference to boolean variable. Returns true if there is a zero on the diagonal in the local part of the Matrix. Otherwise it is false. Different processors might return a different value. There is no global reduction! [in] tol If a row entry's magnitude is less than or equal to this tolerance, the entry is treated as zero.
- Returns
- boolean array. The ith entry is true iff row i is a Dirichlet row.
Definition at line 1038 of file MueLu_UtilitiesBase_def.hpp.
◆ FindNonZeros() [1/2]
|
static |
Find non-zero values in an ArrayRCP Compares the value to 2 * machine epsilon.
- Parameters
-
[in] vals - ArrayRCP<const Scalar> of values to be tested [out] nonzeros - ArrayRCP<bool> of true/false values for whether each entry in vals is nonzero
Definition at line 1073 of file MueLu_UtilitiesBase_def.hpp.
◆ FindNonZeros() [2/2]
|
static |
Find non-zero values in an ArrayRCP Compares the value to 2 * machine epsilon.
- Parameters
-
[in] vals - ArrayRCP<const Scalar> of values to be tested [out] nonzeros - ArrayRCP<bool> of true/false values for whether each entry in vals is nonzero
Definition at line 1087 of file MueLu_UtilitiesBase_def.hpp.
◆ DetectDirichletColsAndDomains() [1/2]
|
static |
Detects Dirichlet columns & domains from a list of Dirichlet rows.
- Parameters
-
[in] A - Matrix on which to apply Dirichlet column detection [in] dirichletRows - ArrayRCP<bool> of indicators as to which rows are Dirichlet [out] dirichletCols - ArrayRCP<bool> of indicators as to which cols are Dirichlet [out] dirichletDomain - ArrayRCP<bool> of indicators as to which domains are Dirichlet
Definition at line 1105 of file MueLu_UtilitiesBase_def.hpp.
◆ DetectDirichletColsAndDomains() [2/2]
|
static |
Detects Dirichlet columns & domains from a list of Dirichlet rows.
- Parameters
-
[in] A - Matrix on which to apply Dirichlet column detection [in] dirichletRows - View<bool> of indicators as to which rows are Dirichlet [out] dirichletCols - View<bool> of indicators as to which cols are Dirichlet [out] dirichletDomain - View<bool> of indicators as to which domains are Dirichlet
Definition at line 1148 of file MueLu_UtilitiesBase_def.hpp.
◆ ApplyRowSumCriterion() [1/3]
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Apply Rowsum Criterion.
Flags a row i as dirichlet if:
\sum_{j\not=i} A_ij > A_ii * tol
- Parameters
-
[in] A matrix [in] rowSumTol See above [in/out] dirichletRows boolean array. The ith entry is true if the above criterion is satisfied (or if it was already set to true)
◆ ApplyRowSumCriterion() [2/3]
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
◆ ApplyRowSumCriterion() [3/3]
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
◆ DetectDirichletCols() [1/2]
|
static |
Detect Dirichlet columns based on Dirichlet rows.
The routine finds all column indices that are in Dirichlet rows, where Dirichlet rows are described by dirichletRows, as returned by DetectDirichletRows.
- Parameters
-
[in] A matrix [in] dirichletRows array of Dirichlet rows.
- Returns
- boolean array. The ith entry is true iff row i is a Dirichlet column.
Definition at line 1300 of file MueLu_UtilitiesBase_def.hpp.
◆ DetectDirichletCols() [2/2]
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Detect Dirichlet columns based on Dirichlet rows.
The routine finds all column indices that are in Dirichlet rows, where Dirichlet rows are described by dirichletRows, as returned by DetectDirichletRows.
- Parameters
-
[in] A matrix [in] dirichletRows array of Dirichlet rows.
- Returns
- boolean array. The ith entry is true iff row i is a Dirichlet column.
◆ Frobenius()
|
static |
Frobenius inner product of two matrices.
Used in energy minimization algorithms
Definition at line 1391 of file MueLu_UtilitiesBase_def.hpp.
◆ SetRandomSeed()
|
static |
Set seed for random number generator.
Distribute the seeds evenly in [1,INT_MAX-1]. This guarantees nothing about where random number streams on difference processes will intersect. This does avoid overflow situations in parallel when multiplying by a PID. It also avoids the pathological case of having the same random number stream on each process.
Definition at line 1453 of file MueLu_UtilitiesBase_def.hpp.
◆ FindDirichletRows()
|
static |
Definition at line 1480 of file MueLu_UtilitiesBase_def.hpp.
◆ ApplyOAZToMatrixRows() [1/3]
|
static |
Definition at line 1504 of file MueLu_UtilitiesBase_def.hpp.
◆ ApplyOAZToMatrixRows() [2/3]
|
static |
Definition at line 1531 of file MueLu_UtilitiesBase_def.hpp.
◆ ApplyOAZToMatrixRows() [3/3]
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
◆ ZeroDirichletRows() [1/5]
|
static |
Definition at line 1606 of file MueLu_UtilitiesBase_def.hpp.
◆ ZeroDirichletRows() [2/5]
|
static |
Definition at line 1624 of file MueLu_UtilitiesBase_def.hpp.
◆ ZeroDirichletRows() [3/5]
|
static |
Definition at line 1645 of file MueLu_UtilitiesBase_def.hpp.
◆ ZeroDirichletRows() [4/5]
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
◆ ZeroDirichletRows() [5/5]
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
◆ ZeroDirichletCols() [1/2]
|
static |
Definition at line 1711 of file MueLu_UtilitiesBase_def.hpp.
◆ ZeroDirichletCols() [2/2]
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
◆ FindDirichletRowsAndPropagateToCols()
|
static |
Definition at line 1757 of file MueLu_UtilitiesBase_def.hpp.
◆ ReplaceNonZerosWithOnes()
|
static |
Creates a copy of a matrix where the non-zero entries are replaced by ones.
Definition at line 1803 of file MueLu_UtilitiesBase_def.hpp.
◆ GeneratedBlockedTargetMap()
|
static |
Definition at line 1837 of file MueLu_UtilitiesBase_def.hpp.
◆ MapsAreNested()
|
static |
Definition at line 1893 of file MueLu_UtilitiesBase_def.hpp.
◆ CuthillMcKee()
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Perform a Cuthill-McKee (CM) or Reverse Cuthill-McKee (RCM) ordering of the local component of the matrix. Kokkos-Kernels has an RCM implementation, so we reverse that here if we call CM.
Definition at line 1946 of file MueLu_UtilitiesBase_def.hpp.
◆ ReverseCuthillMcKee()
template<class Scalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
static |
Perform a Reverse Cuthill-McKee (RCM) ordering of the local component of the matrix.
Definition at line 1916 of file MueLu_UtilitiesBase_def.hpp.
The documentation for this class was generated from the following files:
