Describe a linear system. More...

#include <GlobalLinSysKey.h>

Inheritance diagram for Nektar::MultiRegions::GlobalLinSysKey:

Public Member Functions
	GlobalLinSysKey (const StdRegions::MatrixType matrixType, const AssemblyMapSharedPtr &locToGloMap=NullAssemblyMapSharedPtr, const StdRegions::ConstFactorMap &factors=StdRegions::NullConstFactorMap, const StdRegions::VarCoeffMap &varCoeffs=StdRegions::NullVarCoeffMap, const VarFactorsMap &varFactos=NullVarFactorsMap)

	GlobalLinSysKey (const GlobalLinSysKey &key)
	Copy constructor. More...

virtual	~GlobalLinSysKey ()
	Destructor. More...

GlobalSysSolnType	GetGlobalSysSolnType () const
	Return the associated solution type. More...

int	GetNVarFactors () const

const Array< OneD, const NekDouble > &	GetVarFactors (const StdRegions::ConstFactorType &coeff) const

const VarFactorsMap &	GetVarFactors () const

Public Member Functions inherited from Nektar::MultiRegions::GlobalMatrixKey
	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 Attributes
GlobalSysSolnType	m_solnType
	Store the solution type associated with the linear system. This may be none, full matrix, static condensation or multi-level static condensation. More...

VarFactorsMap	m_varFactors

std::vector< std::size_t >	m_varFactors_hashes

Protected Attributes inherited from Nektar::MultiRegions::GlobalMatrixKey
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 GlobalLinSysKey &lhs, const GlobalLinSysKey &rhs)
	Less-than operator for GlobalLinSysKey comparison. More...

Additional Inherited Members
Protected Member Functions inherited from Nektar::MultiRegions::GlobalMatrixKey
	GlobalMatrixKey ()
	Default constructor. More...

Detailed Description

Describe a linear system.

This class represents a global linear system and is in essence a wrapper around a global matrix key, augmenting it with a specific solution type from GlobalSysSolnType. Each constructor accepts a MatrixType, describing the matrix to be constructed, a AssemblyMap, defining the mapping from the local elemental expansions to a global system, and a GlobalSysSolnType, defining the type of solution (e.g. full matrix, static condenstation). Some constructors include additional parameters for customising the global operator matrix.

Definition at line 50 of file GlobalLinSysKey.h.

Constructor & Destructor Documentation

◆ GlobalLinSysKey() [1/2]

Nektar::MultiRegions::GlobalLinSysKey::GlobalLinSysKey	(	const StdRegions::MatrixType	matrixType,
		const AssemblyMapSharedPtr &	locToGloMap = `NullAssemblyMapSharedPtr`,
		const StdRegions::ConstFactorMap &	factors = `StdRegions::NullConstFactorMap`,
		const StdRegions::VarCoeffMap &	varCoeffs = `StdRegions::NullVarCoeffMap`,
		const VarFactorsMap &	varFactos = `NullVarFactorsMap`
	)

Definition at line 58 of file GlobalLinSysKey.cpp.

                                                      :
             GlobalMatrixKey(matrixType, locToGloMap, factors, varCoeffs),
             m_solnType(locToGloMap->GetGlobalSysSolnType()),
             m_varFactors(varFactors),
             m_varFactors_hashes(varFactors.size())
         {
             // Create hash
             int i = 0;
             for (VarFactorsMap::const_iterator x = varFactors.begin();
                  x != varFactors.end(); ++x)
             {
                 m_varFactors_hashes[i] = boost::hash_range(x->second.begin(),
                               x->second.begin() + x->second.size());
                 boost::hash_combine(m_varFactors_hashes[i], (int)x->first);
                 i++;
             }
         }

References Nektar::hash_combine(), Nektar::hash_range(), and m_varFactors_hashes.

◆ GlobalLinSysKey() [2/2]

Nektar::MultiRegions::GlobalLinSysKey::GlobalLinSysKey ( const GlobalLinSysKey & key )

Copy constructor.

Parameters

key	Existing key to duplicate.

Definition at line 84 of file GlobalLinSysKey.cpp.

                                                                   :
             GlobalMatrixKey(key),
             m_solnType(key.m_solnType),
             m_varFactors(key.m_varFactors),
             m_varFactors_hashes(key.m_varFactors_hashes)
         {
         }

◆ ~GlobalLinSysKey()

Nektar::MultiRegions::GlobalLinSysKey::~GlobalLinSysKey ( )

virtual

Destructor.

Definition at line 96 of file GlobalLinSysKey.cpp.

97 {

98 }

Member Function Documentation

◆ GetGlobalSysSolnType()

GlobalSysSolnType Nektar::MultiRegions::GlobalLinSysKey::GetGlobalSysSolnType ( ) const

inline

Return the associated solution type.

Definition at line 98 of file GlobalLinSysKey.h.

         {
             return m_solnType; 
         }

References m_solnType.

◆ GetNVarFactors()

int Nektar::MultiRegions::GlobalLinSysKey::GetNVarFactors ( ) const

inline

Definition at line 105 of file GlobalLinSysKey.h.

         {
             return m_varFactors.size();
         }

References m_varFactors.

Referenced by Nektar::MultiRegions::GlobalLinSys::GetBlockMatrixKey(), and Nektar::MultiRegions::operator<<().

◆ GetVarFactors() [1/2]

const VarFactorsMap & Nektar::MultiRegions::GlobalLinSysKey::GetVarFactors ( ) const

inline

Definition at line 119 of file GlobalLinSysKey.h.

         {
             return m_varFactors;
         }

References m_varFactors.

◆ GetVarFactors() [2/2]

const Array< OneD, const NekDouble > & Nektar::MultiRegions::GlobalLinSysKey::GetVarFactors ( const StdRegions::ConstFactorType & coeff ) const

inline

Definition at line 111 of file GlobalLinSysKey.h.

         {
             ASSERTL1(m_varFactors.count(factor) > 0, "factor not found");
             VarFactorsMap::const_iterator found = m_varFactors.find(factor);
             return (*found).second;
         }

References ASSERTL1, and m_varFactors.

Referenced by Nektar::MultiRegions::GlobalLinSys::GetBlockMatrixKey().

Friends And Related Function Documentation

◆ operator<

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

friend

Less-than operator for GlobalLinSysKey comparison.

Compares two GlobalLinSysKeys by comparing their solution types and matrix keys.

Parameters

lhs	First operand.
rhs	Second operand.

Returns: true if the first operand is considered less than the second operand.

Definition at line 109 of file GlobalLinSysKey.cpp.

         {
             if(lhs.m_solnType < rhs.m_solnType)
             {
                 return true;
             }
  
             if(lhs.m_solnType > rhs.m_solnType)
             {
                 return false;
             }
  
             if(lhs.m_varFactors.size() < rhs.m_varFactors.size())
             {
                 return true;
             }
  
             if(lhs.m_varFactors.size() > rhs.m_varFactors.size())
             {
                 return false;
             }
  
             for (unsigned int i = 0; i < lhs.m_varFactors_hashes.size(); ++i)
             {
                 if(lhs.m_varFactors_hashes[i] < rhs.m_varFactors_hashes[i])
                 {
                     return true;
                 }
                 if(lhs.m_varFactors_hashes[i] > rhs.m_varFactors_hashes[i])
                 {
                     return false;
                 }
             }
  
             return (*dynamic_cast<const GlobalMatrixKey*>(&lhs)
                     < *dynamic_cast<const GlobalMatrixKey*>(&rhs));
         }

Member Data Documentation

◆ m_solnType

GlobalSysSolnType Nektar::MultiRegions::GlobalLinSysKey::m_solnType

protected

Store the solution type associated with the linear system. This may be none, full matrix, static condensation or multi-level static condensation.

Definition at line 88 of file GlobalLinSysKey.h.

Referenced by GetGlobalSysSolnType().

◆ m_varFactors

VarFactorsMap Nektar::MultiRegions::GlobalLinSysKey::m_varFactors

protected

Definition at line 89 of file GlobalLinSysKey.h.

Referenced by GetNVarFactors(), and GetVarFactors().

◆ m_varFactors_hashes

std::vector<std::size_t> Nektar::MultiRegions::GlobalLinSysKey::m_varFactors_hashes

protected

Definition at line 90 of file GlobalLinSysKey.h.

Referenced by GlobalLinSysKey().

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GlobalLinSysKey() [1/2]

◆ GlobalLinSysKey() [2/2]

◆ ~GlobalLinSysKey()

Member Function Documentation

◆ GetGlobalSysSolnType()

◆ GetNVarFactors()

◆ GetVarFactors() [1/2]

◆ GetVarFactors() [2/2]

Friends And Related Function Documentation

◆ operator<

Member Data Documentation

◆ m_solnType

◆ m_varFactors

◆ m_varFactors_hashes