Nektar::Collections::Helmholtz_MatrixFree Class Reference

Helmholtz operator using matrix free operators. More...

Inheritance diagram for Nektar::Collections::Helmholtz_MatrixFree:

Public Member Functions
	~Helmholtz_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
void	UpdateFactors (StdRegions::FactorMap factors) override
	Update the supplied factor map.
void	UpdateVarcoeffs (StdRegions::VarCoeffMap &varcoeffs) override
	Check the validity of supplied variable coefficients. Note that the m_varcoeffs are not implemented for the MatrixFree operator. There exists a specialised implementation for variable diffusion in the above function UpdateFactors.
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
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
	Helmholtz_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 Member Functions inherited from Nektar::Collections::Helmholtz_Helper
	Helmholtz_Helper ()

Private Attributes
std::shared_ptr< MatrixFree::Helmholtz >	m_oper
unsigned int	m_nmtot
StdRegions::FactorMap	m_factors
StdRegions::VarCoeffMap	m_varcoeffs
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 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

Helmholtz operator using matrix free operators.

Definition at line 586 of file library/Collections/Helmholtz.cpp.

Constructor & Destructor Documentation

~Helmholtz_MatrixFree()

Nektar::Collections::Helmholtz_MatrixFree::~Helmholtz_MatrixFree ( )

finaldefault

Helmholtz_MatrixFree()

Nektar::Collections::Helmholtz_MatrixFree::Helmholtz_MatrixFree ( vector< LocalRegions::ExpansionSharedPtr >  pCollExp, CoalescedGeomDataSharedPtr  pGeomData, StdRegions::FactorMap  factors  )

inlineprivate

Definition at line 713 of file library/Collections/Helmholtz.cpp.

        : Operator(pCollExp, pGeomData, factors),
          MatrixFreeBase(pCollExp[0]->GetNcoeffs(), pCollExp[0]->GetNcoeffs(),
                         pCollExp.size()),
          Helmholtz_Helper()
    {
 
        m_nmtot = m_numElmt * pCollExp[0]->GetNcoeffs();
 
        const auto dim = pCollExp[0]->GetShapeDimension();
 
        // Basis vector.
        std::vector<LibUtilities::BasisSharedPtr> basis(dim);
        for (auto 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 = "Helmholtz";
        op_string += MatrixFree::GetOpstring(shapeType, m_isDeformed);
        auto oper = MatrixFree::GetOperatorFactory().CreateInstance(
            op_string, basis, pCollExp.size());
 
        // Set Jacobian
        oper->SetJac(pGeomData->GetJacInterLeave(pCollExp, m_nElmtPad));
 
        // Store derivative factor
        oper->SetDF(pGeomData->GetDerivFactorsInterLeave(pCollExp, m_nElmtPad));
 
        oper->SetUpBdata(basis);
        oper->SetUpDBdata(basis);
        oper->SetUpZW(basis);
        oper->SetUpD(basis);
 
        m_oper = std::dynamic_pointer_cast<MatrixFree::Helmholtz>(oper);
        ASSERTL0(m_oper, "Failed to cast pointer.");
 
        // Set factors
        m_factors   = StdRegions::NullFactorMap;
        m_varcoeffs = StdRegions::NullVarCoeffMap;
        this->UpdateFactors(factors);
    }

References ASSERTL0, m_factors, Nektar::Collections::Operator::m_isDeformed, Nektar::Collections::MatrixFreeBase::m_nElmtPad, m_nmtot, Nektar::Collections::Operator::m_numElmt, m_oper, m_varcoeffs, Nektar::StdRegions::NullFactorMap, Nektar::StdRegions::NullVarCoeffMap, and UpdateFactors().

Member Function Documentation

operator()() [1/2]

void Nektar::Collections::Helmholtz_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 595 of file library/Collections/Helmholtz.cpp.

    {
        (*m_oper)(input, output0);
    }

operator()() [2/2]

void Nektar::Collections::Helmholtz_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 604 of file library/Collections/Helmholtz.cpp.

    {
        NEKERROR(ErrorUtil::efatal, "Not valid for this operator.");
    }

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

UpdateFactors()

void Nektar::Collections::Helmholtz_MatrixFree::UpdateFactors ( StdRegions::FactorMap  factors )

inlineoverridevirtual

Update the supplied factor map.

Reimplemented from Nektar::Collections::Operator.

Definition at line 615 of file library/Collections/Helmholtz.cpp.

    {
        if (factors == m_factors)
        {
            return;
        }
 
        m_factors = factors;
 
        // Set lambda for this call
        auto x = factors.find(StdRegions::eFactorLambda);
        ASSERTL1(
            x != factors.end(),
            "Constant factor not defined: " +
                std::string(
                    StdRegions::ConstFactorTypeMap[StdRegions::eFactorLambda]));
        m_oper->SetLambda(x->second);
 
        // set constant diffusion coefficients
        bool isConstVarDiff         = false;
        Array<OneD, NekDouble> diff = Array<OneD, NekDouble>(6, 0.0);
        diff[0] = diff[2] = diff[5] = 1.0;
 
        auto xd00 = factors.find(StdRegions::eFactorCoeffD00);
        if (xd00 != factors.end() && xd00->second != 1.0)
        {
            isConstVarDiff = true;
            diff[0]        = xd00->second;
        }
 
        auto xd01 = factors.find(StdRegions::eFactorCoeffD01);
        if (xd01 != factors.end() && xd01->second != 0.0)
        {
            isConstVarDiff = true;
            diff[1]        = xd01->second;
        }
 
        auto xd11 = factors.find(StdRegions::eFactorCoeffD11);
        if (xd11 != factors.end() && xd11->second != 1.0)
        {
            isConstVarDiff = true;
            diff[2]        = xd11->second;
        }
 
        auto xd02 = factors.find(StdRegions::eFactorCoeffD02);
        if (xd02 != factors.end() && xd02->second != 0.0)
        {
            isConstVarDiff = true;
            diff[3]        = xd02->second;
        }
 
        auto xd12 = factors.find(StdRegions::eFactorCoeffD12);
        if (xd12 != factors.end() && xd12->second != 0.0)
        {
            isConstVarDiff = true;
            diff[4]        = xd12->second;
        }
 
        auto xd22 = factors.find(StdRegions::eFactorCoeffD22);
        if (xd22 != factors.end() && xd22->second != 1.0)
        {
            isConstVarDiff = true;
            diff[5]        = xd22->second;
        }
 
        if (isConstVarDiff)
        {
            m_oper->SetConstVarDiffusion(diff);
        }
 
        // set random here for fn variable diffusion
        auto k = factors.find(StdRegions::eFactorTau);
        if (k != factors.end() && k->second != 0.0)
        {
            m_oper->SetVarDiffusion(diff);
        }
    }

References ASSERTL1, Nektar::StdRegions::ConstFactorTypeMap, Nektar::StdRegions::eFactorCoeffD00, Nektar::StdRegions::eFactorCoeffD01, Nektar::StdRegions::eFactorCoeffD02, Nektar::StdRegions::eFactorCoeffD11, Nektar::StdRegions::eFactorCoeffD12, Nektar::StdRegions::eFactorCoeffD22, Nektar::StdRegions::eFactorLambda, Nektar::StdRegions::eFactorTau, m_factors, and m_oper.

Referenced by Helmholtz_MatrixFree().

UpdateVarcoeffs()

void Nektar::Collections::Helmholtz_MatrixFree::UpdateVarcoeffs ( StdRegions::VarCoeffMap &  varcoeffs )

inlineoverridevirtual

Check the validity of supplied variable coefficients. Note that the m_varcoeffs are not implemented for the MatrixFree operator. There exists a specialised implementation for variable diffusion in the above function UpdateFactors.

Parameters

varcoeffs

Map of varcoeffs

Reimplemented from Nektar::Collections::Operator.

Definition at line 702 of file library/Collections/Helmholtz.cpp.

    {
        m_varcoeffs = varcoeffs;
    }

References m_varcoeffs.

Member Data Documentation

m_factors

StdRegions::FactorMap Nektar::Collections::Helmholtz_MatrixFree::m_factors

private

Definition at line 710 of file library/Collections/Helmholtz.cpp.

Referenced by Helmholtz_MatrixFree(), and UpdateFactors().

m_nmtot

unsigned int Nektar::Collections::Helmholtz_MatrixFree::m_nmtot

private

Definition at line 709 of file library/Collections/Helmholtz.cpp.

Referenced by Helmholtz_MatrixFree().

m_oper

std::shared_ptr<MatrixFree::Helmholtz> Nektar::Collections::Helmholtz_MatrixFree::m_oper

private

Definition at line 708 of file library/Collections/Helmholtz.cpp.

Referenced by Helmholtz_MatrixFree(), and UpdateFactors().

m_varcoeffs

StdRegions::VarCoeffMap Nektar::Collections::Helmholtz_MatrixFree::m_varcoeffs

private

Definition at line 711 of file library/Collections/Helmholtz.cpp.

Referenced by Helmholtz_MatrixFree(), and UpdateVarcoeffs().