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.
void	operator() (int dir, const Array< OneD, const NekDouble > &input, Array< OneD, NekDouble > &output, Array< OneD, NekDouble > &wsp) final
Public Member Functions inherited from Nektar::Collections::Operator
	Operator (std::vector< LocalRegions::ExpansionSharedPtr > pCollExp, std::shared_ptr< CoalescedGeomData > GeomData, StdRegions::FactorMap factors)
	Constructor.
virtual	~Operator ()=default
virtual COLLECTIONS_EXPORT void	UpdateFactors (StdRegions::FactorMap factors)
	Update the supplied factor map.
virtual COLLECTIONS_EXPORT void	UpdateVarcoeffs (StdRegions::VarCoeffMap &varcoeffs)
	Update the supplied variable coefficients.
unsigned int	GetWspSize ()
	Get the size of the required workspace.
unsigned int	GetNumElmt ()
	Get number of elements.
StdRegions::StdExpansionSharedPtr	GetExpSharedPtr ()
	Get expansion pointer.
unsigned int	GetInputSize (void)
unsigned int	GetOutputSize (void)
unsigned int	GetPhysSize (void)
unsigned int	GetCoeffSize (void)

Private Member Functions
	PhysDeriv_MatrixFree (vector< LocalRegions::ExpansionSharedPtr > pCollExp, CoalescedGeomDataSharedPtr pGeomData, StdRegions::FactorMap factors)
Private Member Functions inherited from Nektar::Collections::MatrixFreeBase
	MatrixFreeBase ()=default
	MatrixFreeBase (const unsigned int nIn, const unsigned int nOut, const unsigned int nCollSize)

Private Attributes
std::shared_ptr< MatrixFree::PhysDeriv >	m_oper
int	m_coordim
Array< OneD, Array< OneD, NekDouble > >	m_output
Private Attributes inherited from Nektar::Collections::MatrixFreeBase
bool	m_isPadded {false}
	flag for padding
unsigned int	m_nElmtPad
	size after padding
unsigned int	m_nIn
	actural size of input array
unsigned int	m_nOut
	actural size of output array

Additional Inherited Members
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
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
unsigned int	m_outputSize
	number of modes or quadrature points that are taken as output from an operator

Detailed Description

Phys deriv operator using matrix free operators.

Definition at line 272 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< LocalRegions::ExpansionSharedPtr >  pCollExp, CoalescedGeomDataSharedPtr  pGeomData, StdRegions::FactorMap  factors  )

inlineprivate

Definition at line 325 of file PhysDeriv.cpp.

        : Operator(pCollExp, pGeomData, factors), PhysDeriv_Helper(),
          MatrixFreeBase(pCollExp[0]->GetTotPoints(),
                         pCollExp[0]->GetTotPoints(), pCollExp.size())
    {
        // Check if deformed
        bool deformed{pGeomData->IsDeformed(pCollExp)};
        const auto dim = pCollExp[0]->GetShapeDimension();
 
        // only used operator(dir, in, out)
        m_coordim   = pCollExp[0]->GetCoordim();
        int nOut    = pCollExp[0]->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]->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, pCollExp.size());
 
        oper->SetUpZW(basis);
        oper->SetUpD(basis);
 
        // 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, m_coordim, Nektar::Collections::MatrixFreeBase::m_nElmtPad, m_oper, and m_output.

Member Function Documentation

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 281 of file PhysDeriv.cpp.

    {
        Array<OneD, Array<OneD, NekDouble>> output(m_coordim);
        // currently using temporary local temporary space for output
        // to allow for other operator call below which is
        // directionally dependent
        switch (m_coordim)
        {
            case 1:
                output[0] = output0;
                break;
            case 2:
                output[0] = output0;
                output[1] = output1;
                break;
            case 3:
                output[0] = output0;
                output[1] = output1;
                output[2] = output2;
                break;
            default:
                NEKERROR(ErrorUtil::efatal, "Unknown coordinate dimension");
                break;
        }
        (*m_oper)(input, output);
    }

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

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 312 of file PhysDeriv.cpp.

    {
        (*m_oper)(input, m_output);
        Vmath::Vcopy(m_nOut, m_output[dir], 1, output, 1);
    }

References Nektar::Collections::MatrixFreeBase::m_nOut, m_output, and Vmath::Vcopy().

Member Data Documentation

m_coordim

int Nektar::Collections::PhysDeriv_MatrixFree::m_coordim

private

Definition at line 322 of file PhysDeriv.cpp.

Referenced by operator()(), and PhysDeriv_MatrixFree().

m_oper

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

private

Definition at line 321 of file PhysDeriv.cpp.

Referenced by PhysDeriv_MatrixFree().

m_output

Array<OneD, Array<OneD, NekDouble> > Nektar::Collections::PhysDeriv_MatrixFree::m_output

private

Definition at line 323 of file PhysDeriv.cpp.

Referenced by operator()(), and PhysDeriv_MatrixFree().