Nektar++
|
Describes a matrix with ordering defined by a local to global map. More...
#include <GlobalMatrixKey.h>
Public Member Functions | |
GlobalMatrixKey (const StdRegions::MatrixType matrixType, const AssemblyMapSharedPtr &locToGloMap=NullAssemblyMapSharedPtr, const StdRegions::ConstFactorMap &factors=StdRegions::NullConstFactorMap, const StdRegions::VarCoeffMap &varCoeffs=StdRegions::NullVarCoeffMap) | |
GlobalMatrixKey (const GlobalMatrixKey &key, const LibUtilities::ShapeType shapeType) | |
Copy constructor with change in expansion type. More... | |
GlobalMatrixKey (const GlobalMatrixKey &key) | |
Copy constructor. More... | |
virtual | ~GlobalMatrixKey () |
Destructor. More... | |
StdRegions::MatrixType | GetMatrixType () const |
Return the matrix type. More... | |
LibUtilities::ShapeType | GetShapeType () const |
Return the expansion type associated with key. More... | |
bool | LocToGloMapIsDefined () const |
Returns true if a local to global map is defined. More... | |
int | GetNConstFactors () const |
Returns the number of constants defined for this matrix. More... | |
NekDouble | GetConstFactor (const StdRegions::ConstFactorType &factor) const |
Returns the requested constant. More... | |
const StdRegions::ConstFactorMap & | GetConstFactors () const |
Returns all the constants. More... | |
int | GetNVarCoeffs () const |
const Array< OneD, const NekDouble > & | GetVarCoeff (const StdRegions::VarCoeffType &coeff) const |
const StdRegions::VarCoeffMap & | GetVarCoeffs () const |
Protected Member Functions | |
GlobalMatrixKey () | |
Default constructor. More... | |
Protected Attributes | |
StdRegions::MatrixType | m_matrixType |
Stores the matrix type based on the enum StdRegions::MatrixType. More... | |
LibUtilities::ShapeType | m_shapeType |
Stores the expansion/shape type that the matrix is to be based on. More... | |
StdRegions::ConstFactorMap | m_constFactors |
StdRegions::VarCoeffMap | m_varCoeffs |
AssemblyMapSharedPtr | m_locToGloMap |
Pointer to the local to global mapping. More... | |
Friends | |
bool | operator< (const GlobalMatrixKey &lhs, const GlobalMatrixKey &rhs) |
Provides ordering of GlobalMatrixKey objects. More... | |
Describes a matrix with ordering defined by a local to global map.
Definition at line 48 of file GlobalMatrixKey.h.
Nektar::MultiRegions::GlobalMatrixKey::GlobalMatrixKey | ( | const StdRegions::MatrixType | matrixType, |
const AssemblyMapSharedPtr & | locToGloMap = NullAssemblyMapSharedPtr , |
||
const StdRegions::ConstFactorMap & | factors = StdRegions::NullConstFactorMap , |
||
const StdRegions::VarCoeffMap & | varCoeffs = StdRegions::NullVarCoeffMap |
||
) |
Definition at line 43 of file GlobalMatrixKey.cpp.
Nektar::MultiRegions::GlobalMatrixKey::GlobalMatrixKey | ( | const GlobalMatrixKey & | key, |
const LibUtilities::ShapeType | shapeType | ||
) |
Copy constructor with change in expansion type.
Definition at line 55 of file GlobalMatrixKey.cpp.
Nektar::MultiRegions::GlobalMatrixKey::GlobalMatrixKey | ( | const GlobalMatrixKey & | key | ) |
Copy constructor.
Definition at line 65 of file GlobalMatrixKey.cpp.
|
virtual |
|
protected |
Default constructor.
|
inline |
Returns the requested constant.
error checking
Definition at line 143 of file GlobalMatrixKey.h.
References m_constFactors.
|
inline |
Returns all the constants.
Definition at line 150 of file GlobalMatrixKey.h.
References m_constFactors.
Referenced by Nektar::MultiRegions::ExpList::GenBlockMatrix(), Nektar::MultiRegions::ExpList::GeneralMatrixOp_IterPerExp(), Nektar::MultiRegions::ExpList::GenGlobalMatrix(), Nektar::MultiRegions::ExpList::GenGlobalMatrixFull(), Nektar::MultiRegions::operator<<(), Nektar::MultiRegions::PreconditionerLowEnergy::SetUpReferenceElements(), Nektar::MultiRegions::GlobalLinSys::v_DropStaticCondBlock(), Nektar::MultiRegions::GlobalLinSys::v_GetBlock(), and Nektar::MultiRegions::GlobalLinSys::v_GetStaticCondBlock().
|
inline |
Return the matrix type.
Definition at line 116 of file GlobalMatrixKey.h.
References m_matrixType.
Referenced by Nektar::MultiRegions::GlobalLinSysDirectFull::AssembleFullMatrix(), Nektar::MultiRegions::GlobalLinSysXxtFull::AssembleMatrixArrays(), Nektar::MultiRegions::GlobalLinSysDirectStaticCond::DetermineMatrixStorage(), Nektar::MultiRegions::ExpList::GenBlockMatrix(), Nektar::MultiRegions::ExpList::GeneralMatrixOp_IterPerExp(), Nektar::MultiRegions::ExpList::GenGlobalMatrix(), Nektar::MultiRegions::ExpList::GenGlobalMatrixFull(), Nektar::MultiRegions::DisContField2D::GetGlobalBndLinSys(), Nektar::MultiRegions::DisContField3D::GetGlobalBndLinSys(), Nektar::MultiRegions::DisContField1D::GetGlobalBndLinSys(), Nektar::MultiRegions::operator<<(), Nektar::MultiRegions::PreconditionerLowEnergy::SetUpReferenceElements(), Nektar::MultiRegions::GlobalLinSysStaticCond::SetupTopLevel(), Nektar::MultiRegions::GlobalLinSysIterativeStaticCond::v_AssembleSchurComplement(), Nektar::MultiRegions::PreconditionerBlock::v_BuildPreconditioner(), Nektar::MultiRegions::GlobalLinSysIterativeStaticCond::v_DoMatrixMultiply(), Nektar::MultiRegions::GlobalLinSys::v_DropStaticCondBlock(), Nektar::MultiRegions::ContField3D::v_GeneralMatrixOp(), Nektar::MultiRegions::ContField2D::v_GeneralMatrixOp(), Nektar::MultiRegions::GlobalLinSys::v_GetBlock(), Nektar::MultiRegions::GlobalLinSys::v_GetStaticCondBlock(), Nektar::MultiRegions::GlobalLinSysPETScStaticCond::v_InitObject(), and Nektar::MultiRegions::GlobalLinSysIterativeStaticCond::v_InitObject().
|
inline |
Returns the number of constants defined for this matrix.
Definition at line 137 of file GlobalMatrixKey.h.
References m_constFactors.
Referenced by Nektar::MultiRegions::operator<<().
|
inline |
Definition at line 155 of file GlobalMatrixKey.h.
References m_varCoeffs.
Referenced by Nektar::MultiRegions::ExpList::GenBlockMatrix(), Nektar::MultiRegions::ExpList::GeneralMatrixOp_IterPerExp(), Nektar::MultiRegions::ExpList::GenGlobalMatrix(), Nektar::MultiRegions::ExpList::GenGlobalMatrixFull(), Nektar::MultiRegions::operator<<(), Nektar::MultiRegions::PreconditionerLowEnergy::SetUpReferenceElements(), Nektar::MultiRegions::GlobalLinSys::v_DropStaticCondBlock(), Nektar::MultiRegions::GlobalLinSys::v_GetBlock(), and Nektar::MultiRegions::GlobalLinSys::v_GetStaticCondBlock().
|
inline |
Return the expansion type associated with key.
Definition at line 122 of file GlobalMatrixKey.h.
References m_shapeType.
Referenced by Nektar::MultiRegions::ExpList::GenBlockMatrix(), and Nektar::MultiRegions::operator<<().
|
inline |
Definition at line 160 of file GlobalMatrixKey.h.
References m_varCoeffs.
|
inline |
Definition at line 166 of file GlobalMatrixKey.h.
References m_varCoeffs.
Referenced by Nektar::MultiRegions::ExpList::GenBlockMatrix(), Nektar::MultiRegions::ExpList::GeneralMatrixOp_IterPerExp(), Nektar::MultiRegions::ExpList::GenGlobalMatrix(), Nektar::MultiRegions::ExpList::GenGlobalMatrixFull(), Nektar::MultiRegions::PreconditionerLowEnergy::SetUpReferenceElements(), Nektar::MultiRegions::GlobalLinSys::v_DropStaticCondBlock(), Nektar::MultiRegions::GlobalLinSys::v_GetBlock(), and Nektar::MultiRegions::GlobalLinSys::v_GetStaticCondBlock().
|
inline |
Returns true if a local to global map is defined.
Definition at line 127 of file GlobalMatrixKey.h.
References m_locToGloMap.
Referenced by Nektar::MultiRegions::ContField3D::GenGlobalLinSys(), Nektar::MultiRegions::ContField1D::GenGlobalLinSys(), Nektar::MultiRegions::ContField2D::GenGlobalLinSys(), Nektar::MultiRegions::ContField3D::GetGlobalMatrix(), Nektar::MultiRegions::ContField2D::GetGlobalMatrix(), Nektar::MultiRegions::ContField3D::GetGlobalMatrixNnz(), and Nektar::MultiRegions::ContField2D::GetGlobalMatrixNnz().
|
friend |
|
protected |
Definition at line 99 of file GlobalMatrixKey.h.
Referenced by GetConstFactor(), GetConstFactors(), GetNConstFactors(), and Nektar::MultiRegions::operator<().
|
protected |
Pointer to the local to global mapping.
Definition at line 103 of file GlobalMatrixKey.h.
Referenced by LocToGloMapIsDefined(), and Nektar::MultiRegions::operator<().
|
protected |
Stores the matrix type based on the enum StdRegions::MatrixType.
Definition at line 93 of file GlobalMatrixKey.h.
Referenced by GetMatrixType(), and Nektar::MultiRegions::operator<().
|
protected |
Stores the expansion/shape type that the matrix is to be based on.
Definition at line 97 of file GlobalMatrixKey.h.
Referenced by GetShapeType(), and Nektar::MultiRegions::operator<().
|
protected |
Definition at line 100 of file GlobalMatrixKey.h.
Referenced by GetNVarCoeffs(), GetVarCoeff(), GetVarCoeffs(), and Nektar::MultiRegions::operator<().