Nektar::MultiRegions::GlobalMatrixKey Class Reference

Describes a matrix with ordering defined by a local to global map. More...

#include <GlobalMatrixKey.h>

Inheritance diagram for Nektar::MultiRegions::GlobalMatrixKey:

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
std::weak_ptr< AssemblyMap >	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...

Detailed Description

Describes a matrix with ordering defined by a local to global map.

Definition at line 45 of file GlobalMatrixKey.h.

Constructor & Destructor Documentation

GlobalMatrixKey() [1/4]

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 41 of file GlobalMatrixKey.cpp.

    : m_matrixType(matrixType), m_shapeType(LibUtilities::eNoShapeType),
      m_constFactors(factors), m_varCoeffs(varCoeffs),
      m_locToGloMap(locToGloMap)
{
}

GlobalMatrixKey() [2/4]

Nektar::MultiRegions::GlobalMatrixKey::GlobalMatrixKey	(	const GlobalMatrixKey &	key,
		const LibUtilities::ShapeType	shapeType
	)

Copy constructor with change in expansion type.

Definition at line 51 of file GlobalMatrixKey.cpp.

    : m_matrixType(key.m_matrixType), m_shapeType(shapeType),
      m_constFactors(key.m_constFactors), m_varCoeffs(key.m_varCoeffs),
      m_locToGloMap(key.m_locToGloMap)
{
}

GlobalMatrixKey() [3/4]

Nektar::MultiRegions::GlobalMatrixKey::GlobalMatrixKey

(

const GlobalMatrixKey &

key

)

Copy constructor.

Definition at line 59 of file GlobalMatrixKey.cpp.

    : m_matrixType(key.m_matrixType), m_shapeType(key.m_shapeType),
      m_constFactors(key.m_constFactors), m_varCoeffs(key.m_varCoeffs),
      m_locToGloMap(key.m_locToGloMap)
{
}

~GlobalMatrixKey()

Nektar::MultiRegions::GlobalMatrixKey::~GlobalMatrixKey ( )

virtual

Destructor.

Definition at line 66 of file GlobalMatrixKey.cpp.

{
}

GlobalMatrixKey() [4/4]

Nektar::MultiRegions::GlobalMatrixKey::GlobalMatrixKey ( )

protected

Default constructor.

Member Function Documentation

GetConstFactor()

NekDouble Nektar::MultiRegions::GlobalMatrixKey::GetConstFactor ( const StdRegions::ConstFactorType &  factor ) const

inline

Returns the requested constant.

@Todo error checking

Definition at line 142 of file GlobalMatrixKey.h.

{
    auto found = m_constFactors.find(factor);
    return (*found).second;
}

References m_constFactors.

GetConstFactors()

const StdRegions::ConstFactorMap & Nektar::MultiRegions::GlobalMatrixKey::GetConstFactors ( ) const

inline

Returns all the constants.

Definition at line 149 of file GlobalMatrixKey.h.

{
    return m_constFactors;
}

References m_constFactors.

Referenced by Nektar::MultiRegions::ExpList::GenBlockMatrix(), Nektar::MultiRegions::ExpList::GeneralMatrixOp(), Nektar::MultiRegions::ExpList::GenGlobalMatrix(), Nektar::MultiRegions::ExpList::GenGlobalMatrixFull(), Nektar::MultiRegions::GlobalLinSys::GetBlockMatrixKey(), Nektar::MultiRegions::operator<<(), and Nektar::MultiRegions::PreconditionerLowEnergy::SetUpReferenceElements().

GetMatrixType()

StdRegions::MatrixType Nektar::MultiRegions::GlobalMatrixKey::GetMatrixType ( ) const

inline

Return the matrix type.

Definition at line 116 of file GlobalMatrixKey.h.

{
    return m_matrixType;
}

References m_matrixType.

Referenced by Nektar::MultiRegions::GlobalLinSysDirectFull::AssembleFullMatrix(), Nektar::MultiRegions::GlobalLinSysXxtFull::AssembleMatrixArrays(), Nektar::MultiRegions::GlobalLinSysStaticCond::ConstructNextLevelCondensedSystem(), Nektar::MultiRegions::GlobalLinSysDirectStaticCond::DetermineMatrixStorage(), Nektar::MultiRegions::ExpList::GenBlockMatrix(), Nektar::MultiRegions::ExpList::GeneralMatrixOp(), Nektar::MultiRegions::ExpList::GenGlobalMatrix(), Nektar::MultiRegions::ExpList::GenGlobalMatrixFull(), Nektar::MultiRegions::GlobalLinSys::GetBlockMatrixKey(), Nektar::MultiRegions::DisContField::GetGlobalBndLinSys(), Nektar::MultiRegions::GlobalLinSysIterative::GlobalLinSysIterative(), Nektar::MultiRegions::operator<<(), Nektar::MultiRegions::PreconditionerLowEnergy::SetUpReferenceElements(), Nektar::MultiRegions::GlobalLinSysStaticCond::SetupTopLevel(), Nektar::MultiRegions::PreconditionerBlock::v_BuildPreconditioner(), Nektar::MultiRegions::GlobalLinSysIterativeStaticCond::v_InitObject(), and Nektar::MultiRegions::GlobalLinSysPETScStaticCond::v_InitObject().

GetNConstFactors()

int Nektar::MultiRegions::GlobalMatrixKey::GetNConstFactors ( ) const

inline

Returns the number of constants defined for this matrix.

Definition at line 136 of file GlobalMatrixKey.h.

{
    return m_constFactors.size();
}

References m_constFactors.

Referenced by Nektar::MultiRegions::operator<<().

GetNVarCoeffs()

int Nektar::MultiRegions::GlobalMatrixKey::GetNVarCoeffs ( ) const

inline

Definition at line 155 of file GlobalMatrixKey.h.

{
    return m_varCoeffs.size();
}

References m_varCoeffs.

Referenced by Nektar::MultiRegions::ExpList::GenBlockMatrix(), Nektar::MultiRegions::ExpList::GeneralMatrixOp(), Nektar::MultiRegions::ExpList::GenGlobalMatrix(), Nektar::MultiRegions::ExpList::GenGlobalMatrixFull(), Nektar::MultiRegions::GlobalLinSys::GetBlockMatrixKey(), and Nektar::MultiRegions::operator<<().

GetShapeType()

LibUtilities::ShapeType Nektar::MultiRegions::GlobalMatrixKey::GetShapeType ( void  ) const

inline

Return the expansion type associated with key.

Definition at line 121 of file GlobalMatrixKey.h.

{
    return m_shapeType;
}

References m_shapeType.

Referenced by Nektar::MultiRegions::ExpList::GenBlockMatrix(), and Nektar::MultiRegions::operator<<().

GetVarCoeff()

const Array< OneD, const NekDouble > & Nektar::MultiRegions::GlobalMatrixKey::GetVarCoeff ( const StdRegions::VarCoeffType &  coeff ) const

inline

Definition at line 160 of file GlobalMatrixKey.h.

{
    auto found = m_varCoeffs.find(coeff);
    return (*found).second.GetValue();
}

References m_varCoeffs.

GetVarCoeffs()

const StdRegions::VarCoeffMap & Nektar::MultiRegions::GlobalMatrixKey::GetVarCoeffs ( ) const

inline

Definition at line 167 of file GlobalMatrixKey.h.

{
    return m_varCoeffs;
}

References m_varCoeffs.

Referenced by Nektar::MultiRegions::ExpList::GenBlockMatrix(), Nektar::MultiRegions::ExpList::GeneralMatrixOp(), Nektar::MultiRegions::ExpList::GenGlobalMatrix(), Nektar::MultiRegions::ExpList::GenGlobalMatrixFull(), and Nektar::MultiRegions::GlobalLinSys::GetBlockMatrixKey().

LocToGloMapIsDefined()

bool Nektar::MultiRegions::GlobalMatrixKey::LocToGloMapIsDefined ( void  ) const

inline

Returns true if a local to global map is defined.

Definition at line 126 of file GlobalMatrixKey.h.

{
    if (m_locToGloMap.lock().get() == nullptr) // NullAssemblyMapSharedPtr)
    {
        return false;
    }
 
    return true;
}

References m_locToGloMap.

Referenced by Nektar::MultiRegions::ContField::GenGlobalLinSys(), Nektar::MultiRegions::ContField::GetGlobalMatrix(), and Nektar::MultiRegions::ContField::GetGlobalMatrixNnz().

Friends And Related Function Documentation

operator<

bool operator< ( const GlobalMatrixKey &  lhs, const GlobalMatrixKey &  rhs  )

friend

Provides ordering of GlobalMatrixKey objects.

Definition at line 70 of file GlobalMatrixKey.cpp.

{
    if (lhs.m_matrixType < rhs.m_matrixType)
    {
        return true;
    }
 
    if (lhs.m_matrixType > rhs.m_matrixType)
    {
        return false;
    }
 
    if (lhs.m_shapeType < rhs.m_shapeType)
    {
        return true;
    }
 
    if (lhs.m_shapeType > rhs.m_shapeType)
    {
        return false;
    }
 
    if (lhs.m_constFactors.size() < rhs.m_constFactors.size())
    {
        return true;
    }
    else if (lhs.m_constFactors.size() > rhs.m_constFactors.size())
    {
        return false;
    }
    else
    {
        StdRegions::ConstFactorMap::const_iterator x, y;
        for (x = lhs.m_constFactors.begin(), y = rhs.m_constFactors.begin();
             x != lhs.m_constFactors.end(); ++x, ++y)
        {
            if (x->second < y->second)
            {
                return true;
            }
            if (x->second > y->second)
            {
                return false;
            }
        }
    }
 
    if (lhs.m_varCoeffs.size() < rhs.m_varCoeffs.size())
    {
        return true;
    }
    else if (lhs.m_varCoeffs.size() > rhs.m_varCoeffs.size())
    {
        return false;
    }
    else
    {
        StdRegions::VarCoeffMap::const_iterator x, y;
        for (x = lhs.m_varCoeffs.begin(), y = rhs.m_varCoeffs.begin();
             x != lhs.m_varCoeffs.end(); ++x, ++y)
        {
            if (x->second.GetHash() < y->second.GetHash())
            {
                return true;
            }
            if (x->second.GetHash() > y->second.GetHash())
            {
                return false;
            }
        }
    }
 
    if (!rhs.m_locToGloMap.lock().get())
    {
        return false;
    }
    else if (!lhs.m_locToGloMap.lock().get() && rhs.m_locToGloMap.lock().get())
    {
        return true;
    }
    if (lhs.m_locToGloMap.lock()->GetHash() <
        rhs.m_locToGloMap.lock()->GetHash())
    {
        return true;
    }
 
    return false;
}

Member Data Documentation

m_constFactors

StdRegions::ConstFactorMap Nektar::MultiRegions::GlobalMatrixKey::m_constFactors

protected

Definition at line 100 of file GlobalMatrixKey.h.

Referenced by GetConstFactor(), GetConstFactors(), and GetNConstFactors().

m_locToGloMap

std::weak_ptr<AssemblyMap> Nektar::MultiRegions::GlobalMatrixKey::m_locToGloMap

protected

Pointer to the local to global mapping.

Definition at line 104 of file GlobalMatrixKey.h.

Referenced by LocToGloMapIsDefined().

m_matrixType

StdRegions::MatrixType Nektar::MultiRegions::GlobalMatrixKey::m_matrixType

protected

Stores the matrix type based on the enum StdRegions::MatrixType.

Definition at line 94 of file GlobalMatrixKey.h.

Referenced by GetMatrixType().

m_shapeType

LibUtilities::ShapeType Nektar::MultiRegions::GlobalMatrixKey::m_shapeType

protected

Stores the expansion/shape type that the matrix is to be based on.

Definition at line 98 of file GlobalMatrixKey.h.

Referenced by GetShapeType().

m_varCoeffs

StdRegions::VarCoeffMap Nektar::MultiRegions::GlobalMatrixKey::m_varCoeffs

protected

Definition at line 101 of file GlobalMatrixKey.h.

Referenced by GetNVarCoeffs(), GetVarCoeff(), and GetVarCoeffs().