PhysInterp1DScaled help class to calculate the size of the collection that is given as an input and as an output to the PhysInterp1DScaled Operator. The size evaluation takes into account that both the input and the output array belong to the physical space and that the output array can have either a larger, or a smaller size than the input array. More...

Inheritance diagram for Nektar::Collections::PhysInterp1DScaled_Helper:

[legend]

Public Member Functions
void	CheckFactors (StdRegions::FactorMap factors, int coll_phys_offset) override
	Check the validity of the supplied factor map. More...

Public Member Functions inherited from Nektar::Collections::Operator
	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
	PhysInterp1DScaled_Helper ()

Protected Member Functions inherited from Nektar::Collections::Operator
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
StdRegions::FactorMap	m_factors

Protected Attributes inherited from Nektar::Collections::Operator
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

PhysInterp1DScaled help class to calculate the size of the collection that is given as an input and as an output to the PhysInterp1DScaled Operator. The size evaluation takes into account that both the input and the output array belong to the physical space and that the output array can have either a larger, or a smaller size than the input array.

Definition at line 62 of file PhysInterp1DScaled.cpp.

Constructor & Destructor Documentation

◆ PhysInterp1DScaled_Helper()

Nektar::Collections::PhysInterp1DScaled_Helper::PhysInterp1DScaled_Helper ( )

inlineprotected

Definition at line 84 of file PhysInterp1DScaled.cpp.

    {
        NekDouble scale; // declaration of the scaling factor to be used for the
                         // output size
        if (m_factors[StdRegions::eFactorConst] != 0)
        {
            scale = m_factors[StdRegions::eFactorConst];
        }
        else
        {
            scale = 1.5;
        }
 
        // expect input to be number of elements by the number of quad points
        m_inputSize = m_numElmt * m_stdExp->GetTotPoints();
        // expect input to be number of elements by the number of quad points
        int shape_dimension = m_stdExp->GetShapeDimension();
        m_outputSize        = m_numElmt; // initializing m_outputSize
        for (int i = 0; i < shape_dimension; ++i)
        {
            m_outputSize *= (int)(m_stdExp->GetNumPoints(i) * scale);
        }
    }

References Nektar::StdRegions::eFactorConst, m_factors, Nektar::Collections::Operator::m_inputSize, Nektar::Collections::Operator::m_numElmt, Nektar::Collections::Operator::m_outputSize, and Nektar::Collections::Operator::m_stdExp.

Member Function Documentation

◆ CheckFactors()

void Nektar::Collections::PhysInterp1DScaled_Helper::CheckFactors	(	StdRegions::FactorMap	factors,
		int	coll_phys_offset
	)

inlineoverridevirtual

Check the validity of the supplied factor map.

Implements Nektar::Collections::Operator.

Reimplemented in Nektar::Collections::PhysInterp1DScaled_StdMat, Nektar::Collections::PhysInterp1DScaled_MatrixFree, Nektar::Collections::PhysInterp1DScaled_IterPerExp, and Nektar::Collections::PhysInterp1DScaled_NoCollection.

Definition at line 65 of file PhysInterp1DScaled.cpp.

    {
        if (factors == m_factors)
        {
            return;
        }
        m_factors = factors;
 
        // Set scaling factor for the PhysInterp1DScaled function
        [[maybe_unused]] auto x = factors.find(StdRegions::eFactorConst);
        ASSERTL1(
            x != factors.end(),
            "Constant factor not defined: " +
                std::string(
                    StdRegions::ConstFactorTypeMap[StdRegions::eFactorConst]));
    }

References ASSERTL1, Nektar::StdRegions::ConstFactorTypeMap, Nektar::StdRegions::eFactorConst, Nektar::VarcoeffHashingTest::factors, and m_factors.

Referenced by Nektar::Collections::PhysInterp1DScaled_NoCollection::CheckFactors().

Member Data Documentation

◆ m_factors

StdRegions::FactorMap Nektar::Collections::PhysInterp1DScaled_Helper::m_factors

protected

Definition at line 108 of file PhysInterp1DScaled.cpp.

Referenced by CheckFactors(), and PhysInterp1DScaled_Helper().

Public Member Functions

Protected Member Functions