Base class for operators on a collection of elements. More...

#include <Operator.h>

Public Member Functions
	Operator (std::vector< StdRegions::StdExpansionSharedPtr > pCollExp, std::shared_ptr< CoalescedGeomData > GeomData, StdRegions::FactorMap factors)
	Constructor. More...

virtual	~Operator ()=default

virtual COLLECTIONS_EXPORT void	operator() (const Array< OneD, const NekDouble > &input, Array< OneD, NekDouble > &output0, Array< OneD, NekDouble > &output1, Array< OneD, NekDouble > &output2, Array< OneD, NekDouble > &wsp=NullNekDouble1DArray)=0
	Perform operation. More...

virtual COLLECTIONS_EXPORT void	operator() (int dir, const Array< OneD, const NekDouble > &input, Array< OneD, NekDouble > &output, Array< OneD, NekDouble > &wsp=NullNekDouble1DArray)=0

virtual COLLECTIONS_EXPORT void	CheckFactors (StdRegions::FactorMap factors, int coll_phys_offset)=0
	Check the validity of the supplied factor map. More...

unsigned int	GetWspSize ()
	Get the size of the required workspace. More...

unsigned int	GetNumElmt ()
	Get number of elements. More...

StdRegions::StdExpansionSharedPtr	GetExpSharedPtr ()
	Get expansion pointer. More...

unsigned int	GetInputSize ()

unsigned int	GetOutputSize ()

Protected Member Functions
virtual int	v_GetInputSize ()
	This purely virtual function needs to be set-up for every operator inside Collections. It is responsible for returning the size of input collection, that the operator is applied on either in physical or coefficient space. More...

virtual int	v_GetOutputSize ()
	This purely virtual function needs to be set-up for every operator inside Collections. It is responsible for returning the output size either in physical or coefficient space of an operator inside Collections. More...

Protected Attributes
bool	m_isDeformed

StdRegions::StdExpansionSharedPtr	m_stdExp

unsigned int	m_numElmt
	number of elements that the operator is applied on More...

unsigned int	m_nqe

unsigned int	m_wspSize

unsigned int	m_inputSize
	number of modes or quadrature points that are passed as input to an operator More...

unsigned int	m_outputSize
	number of modes or quadrature points that are taken as output from an operator More...

Detailed Description

Base class for operators on a collection of elements.

Definition at line 132 of file Operator.h.

Constructor & Destructor Documentation

◆ Operator()

Nektar::Collections::Operator::Operator	(	std::vector< StdRegions::StdExpansionSharedPtr >	pCollExp,
		std::shared_ptr< CoalescedGeomData >	GeomData,
		StdRegions::FactorMap	factors
	)

Constructor.

Definition at line 66 of file Operator.cpp.

    : m_isDeformed(GeomData->IsDeformed(pCollExp)),
      m_stdExp(pCollExp[0]->GetStdExp()), m_numElmt(pCollExp.size()),
      m_nqe(pCollExp[0]->GetTotPoints()), m_wspSize(0)
{
}

◆ ~Operator()

virtual Nektar::Collections::Operator::~Operator ( )

virtualdefault

Member Function Documentation

◆ CheckFactors()

virtual COLLECTIONS_EXPORT void Nektar::Collections::Operator::CheckFactors	(	StdRegions::FactorMap	factors,
		int	coll_phys_offset
	)

pure virtual

Check the validity of the supplied factor map.

◆ GetExpSharedPtr()

StdRegions::StdExpansionSharedPtr Nektar::Collections::Operator::GetExpSharedPtr ( )

inline

Get expansion pointer.

Definition at line 171 of file Operator.h.

    {
        return m_stdExp;
    }

References m_stdExp.

◆ GetInputSize()

unsigned int Nektar::Collections::Operator::GetInputSize ( )

inline

Definition at line 176 of file Operator.h.

    {
        return m_inputSize;
    }

References m_inputSize.

◆ GetNumElmt()

unsigned int Nektar::Collections::Operator::GetNumElmt ( )

inline

Get number of elements.

Definition at line 165 of file Operator.h.

    {
        return m_numElmt;
    }

References m_numElmt.

◆ GetOutputSize()

unsigned int Nektar::Collections::Operator::GetOutputSize ( )

inline

Definition at line 181 of file Operator.h.

    {
        return m_outputSize;
    }

References m_outputSize.

◆ GetWspSize()

unsigned int Nektar::Collections::Operator::GetWspSize ( )

inline

Get the size of the required workspace.

Definition at line 159 of file Operator.h.

    {
        return m_wspSize;
    }

References m_wspSize.

◆ operator()() [1/2]

virtual COLLECTIONS_EXPORT void Nektar::Collections::Operator::operator()	(	const Array< OneD, const NekDouble > &	input,
		Array< OneD, NekDouble > &	output0,
		Array< OneD, NekDouble > &	output1,
		Array< OneD, NekDouble > &	output2,
		Array< OneD, NekDouble > &	wsp = `NullNekDouble1DArray`
	)

pure virtual

Perform operation.

◆ operator()() [2/2]

virtual COLLECTIONS_EXPORT void Nektar::Collections::Operator::operator()	(	int	dir,
		const Array< OneD, const NekDouble > &	input,
		Array< OneD, NekDouble > &	output,
		Array< OneD, NekDouble > &	wsp = `NullNekDouble1DArray`
	)

pure virtual

◆ v_GetInputSize()

virtual int Nektar::Collections::Operator::v_GetInputSize ( )

inlineprotectedvirtual

This purely virtual function needs to be set-up for every operator inside Collections. It is responsible for returning the size of input collection, that the operator is applied on either in physical or coefficient space.

Returns: Returns 0. The actual implementation is inside the specific operator class.

Definition at line 206 of file Operator.h.

    {
        NEKERROR(ErrorUtil::efatal,
                 "This method is not defined or valid for this class type");
        return 0;
    }

References Nektar::ErrorUtil::efatal, and NEKERROR.

◆ v_GetOutputSize()

virtual int Nektar::Collections::Operator::v_GetOutputSize ( )

inlineprotectedvirtual

This purely virtual function needs to be set-up for every operator inside Collections. It is responsible for returning the output size either in physical or coefficient space of an operator inside Collections.

Returns: Returns 0. The actual implementation is inside the specific operator class.

Definition at line 218 of file Operator.h.

    {
        NEKERROR(ErrorUtil::efatal,
                 "This method is not defined or valid for this class type");
        return 0;
    }

References Nektar::ErrorUtil::efatal, and NEKERROR.

Member Data Documentation

◆ m_inputSize

unsigned int Nektar::Collections::Operator::m_inputSize

protected

number of modes or quadrature points that are passed as input to an operator

Definition at line 195 of file Operator.h.

Referenced by Nektar::Collections::BwdTrans_Helper::BwdTrans_Helper(), GetInputSize(), Nektar::Collections::Helmholtz_Helper::Helmholtz_Helper(), Nektar::Collections::IProductWRTBase_Helper::IProductWRTBase_Helper(), Nektar::Collections::IProductWRTDerivBase_Helper::IProductWRTDerivBase_Helper(), Nektar::Collections::PhysDeriv_Helper::PhysDeriv_Helper(), and Nektar::Collections::PhysInterp1DScaled_Helper::PhysInterp1DScaled_Helper().

◆ m_isDeformed

bool Nektar::Collections::Operator::m_isDeformed

protected

Definition at line 187 of file Operator.h.

◆ m_nqe

unsigned int Nektar::Collections::Operator::m_nqe

protected

Definition at line 191 of file Operator.h.

◆ m_numElmt

unsigned int Nektar::Collections::Operator::m_numElmt

protected

number of elements that the operator is applied on

Definition at line 190 of file Operator.h.

◆ m_outputSize

unsigned int Nektar::Collections::Operator::m_outputSize

protected

number of modes or quadrature points that are taken as output from an operator

Definition at line 198 of file Operator.h.

Referenced by Nektar::Collections::BwdTrans_Helper::BwdTrans_Helper(), GetOutputSize(), Nektar::Collections::Helmholtz_Helper::Helmholtz_Helper(), Nektar::Collections::IProductWRTBase_Helper::IProductWRTBase_Helper(), Nektar::Collections::IProductWRTDerivBase_Helper::IProductWRTDerivBase_Helper(), Nektar::Collections::PhysDeriv_Helper::PhysDeriv_Helper(), and Nektar::Collections::PhysInterp1DScaled_Helper::PhysInterp1DScaled_Helper().

◆ m_stdExp

StdRegions::StdExpansionSharedPtr Nektar::Collections::Operator::m_stdExp

protected

Definition at line 188 of file Operator.h.

◆ m_wspSize

unsigned int Nektar::Collections::Operator::m_wspSize

protected

Definition at line 192 of file Operator.h.

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Operator()

◆ ~Operator()

Member Function Documentation

◆ CheckFactors()

◆ GetExpSharedPtr()

◆ GetInputSize()

◆ GetNumElmt()

◆ GetOutputSize()

◆ GetWspSize()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ v_GetInputSize()

◆ v_GetOutputSize()

Member Data Documentation

◆ m_inputSize

◆ m_isDeformed

◆ m_nqe

◆ m_numElmt

◆ m_outputSize

◆ m_stdExp

◆ m_wspSize