Nektar::Collections::PhysDeriv_MatrixFree Class Reference

Phys deriv operator using matrix free operators. More...

Inheritance diagram for Nektar::Collections::PhysDeriv_MatrixFree:

Public Member Functions
	~PhysDeriv_MatrixFree () final=default
void	operator() (const Array< OneD, const NekDouble > &input, Array< OneD, NekDouble > &output0, Array< OneD, NekDouble > &output1, Array< OneD, NekDouble > &output2, Array< OneD, NekDouble > &wsp) final
	Perform operation. More...
void	operator() (int dir, const Array< OneD, const NekDouble > &input, Array< OneD, NekDouble > &output, Array< OneD, NekDouble > &wsp) final
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 ()

Private Member Functions
	PhysDeriv_MatrixFree (vector< StdRegions::StdExpansionSharedPtr > pCollExp, CoalescedGeomDataSharedPtr pGeomData, StdRegions::FactorMap factors)
Private Member Functions inherited from Nektar::Collections::MatrixFreeOneInMultiOut
	MatrixFreeOneInMultiOut (const unsigned int coordim, const unsigned int nIn, const unsigned int nOut, const unsigned int nCollSize)
	Constructor. More...

Private Attributes
std::shared_ptr< MatrixFree::PhysDeriv >	m_oper
Private Attributes inherited from Nektar::Collections::MatrixFreeOneInMultiOut
unsigned short	m_coordim
	coordinates dimension More...
Array< OneD, NekDouble >	m_input
	padded input/output vectors More...
Array< OneD, Array< OneD, NekDouble > >	m_output

Additional Inherited Members
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 Member Functions inherited from Nektar::Collections::PhysDeriv_Helper
	PhysDeriv_Helper ()
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

Phys deriv operator using matrix free operators.

Definition at line 275 of file PhysDeriv.cpp.

Constructor & Destructor Documentation

~PhysDeriv_MatrixFree()

Nektar::Collections::PhysDeriv_MatrixFree::~PhysDeriv_MatrixFree ( )

finaldefault

PhysDeriv_MatrixFree()

Nektar::Collections::PhysDeriv_MatrixFree::PhysDeriv_MatrixFree ( vector< StdRegions::StdExpansionSharedPtr >  pCollExp, CoalescedGeomDataSharedPtr  pGeomData, StdRegions::FactorMap  factors  )

inlineprivate

Definition at line 350 of file PhysDeriv.cpp.

        : Operator(pCollExp, pGeomData, factors), PhysDeriv_Helper(),
          MatrixFreeOneInMultiOut(pCollExp[0]->GetCoordim(),
                                  pCollExp[0]->GetStdExp()->GetTotPoints(),
                                  pCollExp[0]->GetStdExp()->GetTotPoints(),
                                  pCollExp.size())
    {
        // Check if deformed
        bool deformed{pGeomData->IsDeformed(pCollExp)};
        const auto dim = pCollExp[0]->GetStdExp()->GetShapeDimension();
 
        if (m_isPadded == false) // declare local space non-padded case
        {
            int nOut    = pCollExp[0]->GetStdExp()->GetTotPoints();
            m_output    = Array<OneD, Array<OneD, NekDouble>>(m_coordim);
            m_output[0] = Array<OneD, NekDouble>{nOut * m_nElmtPad, 0.0};
            if (m_coordim == 2)
            {
                m_output[1] = Array<OneD, NekDouble>{nOut * m_nElmtPad, 0.0};
            }
            else if (m_coordim == 3)
            {
                m_output[1] = Array<OneD, NekDouble>{nOut * m_nElmtPad, 0.0};
                m_output[2] = Array<OneD, NekDouble>{nOut * m_nElmtPad, 0.0};
            }
        }
 
        // Basis vector.
        std::vector<LibUtilities::BasisSharedPtr> basis(dim);
        for (unsigned int i = 0; i < dim; ++i)
        {
            basis[i] = pCollExp[0]->GetBasis(i);
        }
 
        // Get shape type
        auto shapeType = pCollExp[0]->GetStdExp()->DetShapeType();
 
        // Generate operator string and create operator.
        std::string op_string = "PhysDeriv";
        op_string += MatrixFree::GetOpstring(shapeType, deformed);
        auto oper = MatrixFree::GetOperatorFactory().CreateInstance(
            op_string, basis, m_nElmtPad);
 
        // Set derivative factors
        oper->SetDF(pGeomData->GetDerivFactorsInterLeave(pCollExp, m_nElmtPad));
 
        m_oper = std::dynamic_pointer_cast<MatrixFree::PhysDeriv>(oper);
        ASSERTL0(m_oper, "Failed to cast pointer.");
    }

References ASSERTL0, Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), Nektar::Collections::GetOperatorFactory(), Nektar::Collections::MatrixFreeOneInMultiOut::m_coordim, Nektar::Collections::MatrixFreeBase::m_isPadded, Nektar::Collections::MatrixFreeBase::m_nElmtPad, m_oper, and Nektar::Collections::MatrixFreeOneInMultiOut::m_output.

Member Function Documentation

CheckFactors()

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

inlineoverridevirtual

Check the validity of the supplied factor map.

Implements Nektar::Collections::Operator.

Definition at line 341 of file PhysDeriv.cpp.

    {
        ASSERTL0(false, "Not valid for this operator.");
    }

References ASSERTL0.

operator()() [1/2]

void Nektar::Collections::PhysDeriv_MatrixFree::operator() ( const Array< OneD, const NekDouble > &  input, Array< OneD, NekDouble > &  output0, Array< OneD, NekDouble > &  output1, Array< OneD, NekDouble > &  output2, Array< OneD, NekDouble > &  wsp  )

inlinefinalvirtual

Perform operation.

Implements Nektar::Collections::Operator.

Definition at line 284 of file PhysDeriv.cpp.

    {
        if (m_isPadded)
        {
            // copy into padded vector
            Vmath::Vcopy(m_nIn, input, 1, m_input, 1);
            (*m_oper)(m_input, m_output);
        }
        else
        {
            (*m_oper)(input, m_output);
        }
 
        // currently using temporary local temporary space for output
        // to allow for other operator call below which is
        // directionally dependent
        switch (m_coordim)
        {
            case 1:
                Vmath::Vcopy(m_nOut, m_output[0], 1, output0, 1);
                break;
            case 2:
                Vmath::Vcopy(m_nOut, m_output[0], 1, output0, 1);
                Vmath::Vcopy(m_nOut, m_output[1], 1, output1, 1);
                break;
            case 3:
                Vmath::Vcopy(m_nOut, m_output[0], 1, output0, 1);
                Vmath::Vcopy(m_nOut, m_output[1], 1, output1, 1);
                Vmath::Vcopy(m_nOut, m_output[2], 1, output2, 1);
                break;
            default:
                NEKERROR(ErrorUtil::efatal, "Unknown coordinate dimension");
                break;
        }
    }

References Nektar::ErrorUtil::efatal, Nektar::Collections::MatrixFreeOneInMultiOut::m_coordim, Nektar::Collections::MatrixFreeOneInMultiOut::m_input, Nektar::Collections::MatrixFreeBase::m_isPadded, Nektar::Collections::MatrixFreeBase::m_nIn, Nektar::Collections::MatrixFreeBase::m_nOut, Nektar::Collections::MatrixFreeOneInMultiOut::m_output, NEKERROR, and Vmath::Vcopy().

operator()() [2/2]

void Nektar::Collections::PhysDeriv_MatrixFree::operator() ( int  dir, const Array< OneD, const NekDouble > &  input, Array< OneD, NekDouble > &  output, Array< OneD, NekDouble > &  wsp  )

inlinefinalvirtual

Implements Nektar::Collections::Operator.

Definition at line 324 of file PhysDeriv.cpp.

    {
        if (m_isPadded)
        {
            // copy into padded vector
            Vmath::Vcopy(m_nIn, input, 1, m_input, 1);
            (*m_oper)(m_input, m_output);
        }
        else
        {
            (*m_oper)(input, m_output);
        }
        Vmath::Vcopy(m_nOut, m_output[dir], 1, output, 1);
    }

References Nektar::Collections::MatrixFreeOneInMultiOut::m_input, Nektar::Collections::MatrixFreeBase::m_isPadded, Nektar::Collections::MatrixFreeBase::m_nIn, Nektar::Collections::MatrixFreeBase::m_nOut, Nektar::Collections::MatrixFreeOneInMultiOut::m_output, and Vmath::Vcopy().

Member Data Documentation

m_oper

std::shared_ptr<MatrixFree::PhysDeriv> Nektar::Collections::PhysDeriv_MatrixFree::m_oper

private

Definition at line 348 of file PhysDeriv.cpp.

Referenced by PhysDeriv_MatrixFree().