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	UpdateFactors (StdRegions::FactorMap factors)
	Update the supplied factor map. More...

virtual COLLECTIONS_EXPORT void	UpdateVarcoeffs (StdRegions::VarCoeffMap &varcoeffs)
	Update the supplied variable coefficients. 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 (bool defaultIn=true)

unsigned int	GetOutputSize (bool defaultOut=true)

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...

unsigned int	m_inputSizeOther
	Number of modes or quadrature points, opposite to m_inputSize. More...

unsigned int	m_outputSizeOther
	Number of modes or quadrature points, opposite to m_outputSize. More...

Detailed Description

Base class for operators on a collection of elements.

Definition at line 137 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

◆ GetExpSharedPtr()

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

inline

Get expansion pointer.

Definition at line 190 of file Operator.h.

    {
        return m_stdExp;
    }

References m_stdExp.

◆ GetInputSize()

unsigned int Nektar::Collections::Operator::GetInputSize ( bool defaultIn = true )

inline

Definition at line 199 of file Operator.h.

    {
        return (m_inputSizeOther && !defaultIn) ? m_inputSizeOther
                                                : m_inputSize;
    }

References m_inputSize, and m_inputSizeOther.

◆ GetNumElmt()

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

inline

Get number of elements.

Definition at line 184 of file Operator.h.

    {
        return m_numElmt;
    }

References m_numElmt.

◆ GetOutputSize()

unsigned int Nektar::Collections::Operator::GetOutputSize ( bool defaultOut = true )

inline

Definition at line 209 of file Operator.h.

    {
        return (m_outputSizeOther && !defaultOut) ? m_outputSizeOther
                                                  : m_outputSize;
    }

References m_outputSize, and m_outputSizeOther.

◆ GetWspSize()

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

inline

Get the size of the required workspace.

Definition at line 178 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

◆ UpdateFactors()

virtual COLLECTIONS_EXPORT void Nektar::Collections::Operator::UpdateFactors ( StdRegions::FactorMap factors )

inlinevirtual

Update the supplied factor map.

Definition at line 160 of file Operator.h.

    {
        ASSERTL0(false, "This method needs to be re-implemented in derived "
                        "operator class.");
    }

References ASSERTL0.

◆ UpdateVarcoeffs()

virtual COLLECTIONS_EXPORT void Nektar::Collections::Operator::UpdateVarcoeffs ( StdRegions::VarCoeffMap & varcoeffs )

inlinevirtual

Update the supplied variable coefficients.

Reimplemented in Nektar::Collections::Helmholtz_NoCollection, Nektar::Collections::Helmholtz_IterPerExp, Nektar::Collections::Helmholtz_MatrixFree, Nektar::Collections::LinearAdvectionDiffusionReaction_NoCollection, Nektar::Collections::LinearAdvectionDiffusionReaction_IterPerExp, and Nektar::Collections::LinearAdvectionDiffusionReaction_MatrixFree.

Definition at line 168 of file Operator.h.

    {
        ASSERTL0(false,
                 "This method needs to be re-implemented in derived "
                 "operator class. Make sure it is implemented for the operator"
                 " in the .opt file");
    }

References ASSERTL0.

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 224 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::LinearAdvectionDiffusionReaction_Helper::LinearAdvectionDiffusionReaction_Helper(), Nektar::Collections::PhysDeriv_Helper::PhysDeriv_Helper(), and Nektar::Collections::PhysInterp1DScaled_Helper::PhysInterp1DScaled_Helper().

◆ m_inputSizeOther

unsigned int Nektar::Collections::Operator::m_inputSizeOther

protected

Number of modes or quadrature points, opposite to m_inputSize.

Definition at line 229 of file Operator.h.

Referenced by GetInputSize(), Nektar::Collections::Helmholtz_Helper::Helmholtz_Helper(), and Nektar::Collections::LinearAdvectionDiffusionReaction_Helper::LinearAdvectionDiffusionReaction_Helper().

◆ m_isDeformed

bool Nektar::Collections::Operator::m_isDeformed

protected

Definition at line 216 of file Operator.h.

◆ m_nqe

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

protected

Definition at line 220 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 219 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 227 of file Operator.h.

◆ m_outputSizeOther

unsigned int Nektar::Collections::Operator::m_outputSizeOther

protected

Number of modes or quadrature points, opposite to m_outputSize.

Definition at line 231 of file Operator.h.

Referenced by GetOutputSize(), Nektar::Collections::Helmholtz_Helper::Helmholtz_Helper(), and Nektar::Collections::LinearAdvectionDiffusionReaction_Helper::LinearAdvectionDiffusionReaction_Helper().

◆ m_stdExp

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

protected

Definition at line 217 of file Operator.h.

◆ m_wspSize

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

protected

Definition at line 221 of file Operator.h.

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Operator()

◆ ~Operator()

Member Function Documentation

◆ GetExpSharedPtr()

◆ GetInputSize()

◆ GetNumElmt()

◆ GetOutputSize()

◆ GetWspSize()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ UpdateFactors()

◆ UpdateVarcoeffs()

Member Data Documentation

◆ m_inputSize

◆ m_inputSizeOther

◆ m_isDeformed

◆ m_nqe

◆ m_numElmt

◆ m_outputSize

◆ m_outputSizeOther

◆ m_stdExp

◆ m_wspSize