#include <Collection.h>

Public Member Functions
COLLECTIONS_EXPORT	Collection (std::vector< StdRegions::StdExpansionSharedPtr > pCollExp, OperatorImpMap &impTypes)

COLLECTIONS_EXPORT void	UpdateFactors (const OperatorType opType, StdRegions::FactorMap factors)
	Update the factor map in operator.

COLLECTIONS_EXPORT void	UpdateVarcoeffs (const OperatorType opType, StdRegions::VarCoeffMap &varcoeffs=StdRegions::NullVarCoeffMap)

COLLECTIONS_EXPORT void	Initialise (const OperatorType opType, StdRegions::FactorMap factors=StdRegions::NullFactorMap)

void	ApplyOperator (const OperatorType &op, const Array< OneD, const NekDouble > &inarray, Array< OneD, NekDouble > &output)

void	ApplyOperator (const OperatorType &op, const Array< OneD, const NekDouble > &inarray, Array< OneD, NekDouble > &output0, Array< OneD, NekDouble > &output1)

void	ApplyOperator (const OperatorType &op, const Array< OneD, const NekDouble > &inarray, Array< OneD, NekDouble > &output0, Array< OneD, NekDouble > &output1, Array< OneD, NekDouble > &output2)

void	ApplyOperator (const OperatorType &op, int dir, const Array< OneD, const NekDouble > &inarray, Array< OneD, NekDouble > &output)

bool	HasOperator (const OperatorType &op)

OperatorSharedPtr	GetOpSharedPtr (const OperatorType &op)

CoalescedGeomDataSharedPtr	GetGeomSharedPtr ()

std::vector< StdRegions::StdExpansionSharedPtr > &	GetExpVector ()

int	GetInputSize (const OperatorType &op, bool defaultIn=true)

int	GetOutputSize (const OperatorType &op, bool defaultOut=true)

int	GetNumElmt (const OperatorType &op)
	Return the number of elements in collection attached to.

Protected Attributes
std::unordered_map< OperatorType, OperatorSharedPtr >	m_ops

CoalescedGeomDataSharedPtr	m_geomData

std::vector< StdRegions::StdExpansionSharedPtr >	m_collExp

OperatorImpMap	m_impTypes

Detailed Description

Collection.

Definition at line 53 of file Collection.h.

Constructor & Destructor Documentation

◆ Collection()

Nektar::Collections::Collection::Collection	(	std::vector< StdRegions::StdExpansionSharedPtr >	pCollExp,
		OperatorImpMap &	impTypes
	)

Definition at line 46 of file Collection.cpp.

    : m_collExp(pCollExp), m_impTypes(impTypes)
{
    // Initialise geometry data.
    m_geomData = MemoryManager<CoalescedGeomData>::AllocateSharedPtr();
}

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), and m_geomData.

Member Function Documentation

◆ ApplyOperator() [1/4]

void Nektar::Collections::Collection::ApplyOperator	(	const OperatorType &	op,
		const Array< OneD, const NekDouble > &	inarray,
		Array< OneD, NekDouble > &	output
	)

inline

Definition at line 138 of file Collection.h.

{
    Array<OneD, NekDouble> wsp(m_ops[op]->GetWspSize());
    (*m_ops[op])(inarray, output, NullNekDouble1DArray, NullNekDouble1DArray,
                 wsp);
}

References m_ops, and Nektar::NullNekDouble1DArray.

◆ ApplyOperator() [2/4]

void Nektar::Collections::Collection::ApplyOperator	(	const OperatorType &	op,
		const Array< OneD, const NekDouble > &	inarray,
		Array< OneD, NekDouble > &	output0,
		Array< OneD, NekDouble > &	output1
	)

inline

Definition at line 150 of file Collection.h.

{
    Array<OneD, NekDouble> wsp(m_ops[op]->GetWspSize());
    (*m_ops[op])(inarray, output0, output1, NullNekDouble1DArray, wsp);
}

References m_ops, and Nektar::NullNekDouble1DArray.

◆ ApplyOperator() [3/4]

void Nektar::Collections::Collection::ApplyOperator	(	const OperatorType &	op,
		const Array< OneD, const NekDouble > &	inarray,
		Array< OneD, NekDouble > &	output0,
		Array< OneD, NekDouble > &	output1,
		Array< OneD, NekDouble > &	output2
	)

inline

Definition at line 161 of file Collection.h.

{
    Array<OneD, NekDouble> wsp(m_ops[op]->GetWspSize());
    (*m_ops[op])(inarray, output0, output1, output2, wsp);
}

References m_ops.

◆ ApplyOperator() [4/4]

void Nektar::Collections::Collection::ApplyOperator	(	const OperatorType &	op,
		int	dir,
		const Array< OneD, const NekDouble > &	inarray,
		Array< OneD, NekDouble > &	output
	)

inline

Definition at line 173 of file Collection.h.

{
    Array<OneD, NekDouble> wsp(m_ops[op]->GetWspSize());
    (*m_ops[op])(dir, inarray, output, wsp);
}

References m_ops.

◆ GetExpVector()

std::vector< StdRegions::StdExpansionSharedPtr > & Nektar::Collections::Collection::GetExpVector ( )

inline

Definition at line 102 of file Collection.h.

    {
        return m_collExp;
    }

References m_collExp.

◆ GetGeomSharedPtr()

CoalescedGeomDataSharedPtr Nektar::Collections::Collection::GetGeomSharedPtr ( )

inline

Definition at line 98 of file Collection.h.

    {
        return m_geomData;
    }

References m_geomData.

◆ GetInputSize()

int Nektar::Collections::Collection::GetInputSize	(	const OperatorType &	op,
		bool	defaultIn = `true`
	)

inline

Definition at line 107 of file Collection.h.

    {
        return m_ops[op]->GetInputSize(defaultIn);
    }

References m_ops.

◆ GetNumElmt()

int Nektar::Collections::Collection::GetNumElmt ( const OperatorType & op )

inline

Return the number of elements in collection attached to.

Parameters

op

Definition at line 118 of file Collection.h.

    {
        return m_ops[op]->GetNumElmt();
    }

References m_ops.

◆ GetOpSharedPtr()

OperatorSharedPtr Nektar::Collections::Collection::GetOpSharedPtr ( const OperatorType & op )

inline

Definition at line 93 of file Collection.h.

    {
        return m_ops[op];
    }

References m_ops.

◆ GetOutputSize()

int Nektar::Collections::Collection::GetOutputSize	(	const OperatorType &	op,
		bool	defaultOut = `true`
	)

inline

Definition at line 112 of file Collection.h.

    {
        return m_ops[op]->GetOutputSize(defaultOut);
    }

References m_ops.

◆ HasOperator()

bool Nektar::Collections::Collection::HasOperator ( const OperatorType & op )

inline

Definition at line 181 of file Collection.h.

{
    return (m_ops.find(op) != m_ops.end());
}

References m_ops.

Referenced by Initialise().

◆ Initialise()

void Nektar::Collections::Collection::Initialise	(	const OperatorType	opType,
		StdRegions::FactorMap	factors = `StdRegions::NullFactorMap`
	)

Definition at line 66 of file Collection.cpp.

{
    if (!HasOperator(opType))
    {
        auto it = m_impTypes.find(opType);
 
        if (it != m_impTypes.end())
        {
            ImplementationType impType = it->second;
            OperatorKey opKey(m_collExp[0]->DetShapeType(), opType, impType,
                              m_collExp[0]->IsNodalNonTensorialExp());
 
            stringstream ss;
            ss << opKey;
            ASSERTL0(GetOperatorFactory().ModuleExists(opKey),
                     "Requested unknown operator " + ss.str());
 
            m_ops[opType] = GetOperatorFactory().CreateInstance(
                opKey, m_collExp, m_geomData, factors);
        }
        else
        {
            WARNINGL2(false,
                      "Failed to determine implmentation to initialise "
                      "collection operator: " +
                          std::string(Collections::OperatorTypeMap[opType]));
        }
    }
}

References ASSERTL0, Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), Nektar::Collections::GetOperatorFactory(), HasOperator(), m_collExp, m_geomData, m_impTypes, m_ops, Nektar::Collections::OperatorTypeMap, and WARNINGL2.

◆ UpdateFactors()

void Nektar::Collections::Collection::UpdateFactors	(	const OperatorType	opType,
		StdRegions::FactorMap	factors
	)

Update the factor map in operator.

Parameters

opType	by input
factors

Definition at line 54 of file Collection.cpp.

{
    m_ops[opType]->UpdateFactors(factors);
}

References m_ops.

◆ UpdateVarcoeffs()

void Nektar::Collections::Collection::UpdateVarcoeffs	(	const OperatorType	opType,
		StdRegions::VarCoeffMap &	varcoeffs = `StdRegions::NullVarCoeffMap`
	)

Definition at line 60 of file Collection.cpp.

{
    m_ops[opType]->UpdateVarcoeffs(varcoeffs);
}

References m_ops.

Referenced by Nektar::Collections::CollectionOptimisation::SetWithTimings().

Member Data Documentation

◆ m_collExp

std::vector<StdRegions::StdExpansionSharedPtr> Nektar::Collections::Collection::m_collExp

protected

Definition at line 128 of file Collection.h.

Referenced by GetExpVector(), and Initialise().

◆ m_geomData

CoalescedGeomDataSharedPtr Nektar::Collections::Collection::m_geomData

protected

Definition at line 125 of file Collection.h.

Referenced by Collection(), GetGeomSharedPtr(), and Initialise().

◆ m_impTypes

OperatorImpMap Nektar::Collections::Collection::m_impTypes

protected

Definition at line 129 of file Collection.h.

Referenced by Initialise().

◆ m_ops

std::unordered_map<OperatorType, OperatorSharedPtr> Nektar::Collections::Collection::m_ops

protected

Definition at line 124 of file Collection.h.

Referenced by ApplyOperator(), ApplyOperator(), ApplyOperator(), ApplyOperator(), GetInputSize(), GetNumElmt(), GetOpSharedPtr(), GetOutputSize(), HasOperator(), Initialise(), UpdateFactors(), and UpdateVarcoeffs().

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Collection()

Member Function Documentation

◆ ApplyOperator() [1/4]

◆ ApplyOperator() [2/4]

◆ ApplyOperator() [3/4]

◆ ApplyOperator() [4/4]

◆ GetExpVector()

◆ GetGeomSharedPtr()

◆ GetInputSize()

◆ GetNumElmt()

◆ GetOpSharedPtr()

◆ GetOutputSize()

◆ HasOperator()

◆ Initialise()

◆ UpdateFactors()

◆ UpdateVarcoeffs()

Member Data Documentation

◆ m_collExp

◆ m_geomData

◆ m_impTypes

◆ m_ops