FilterWrap Struct Reference

Filter wrapper to handle virtual function calls in Filter and its subclasses. More...

Inheritance diagram for FilterWrap:

Public Member Functions
	FilterWrap (LibUtilities::SessionReaderSharedPtr session, std::shared_ptr< EquationSystem > eqn)
	Constructor, which is identical to Filter. More...
py::list	ArrayOneDToPyList (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields)
void	v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
void	v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
void	v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
bool	v_IsTimeDependent () override
Public Member Functions inherited from Nektar::SolverUtils::Filter
SOLVER_UTILS_EXPORT	Filter (const LibUtilities::SessionReaderSharedPtr &pSession, const std::shared_ptr< EquationSystem > &pEquation)
virtual SOLVER_UTILS_EXPORT	~Filter ()
SOLVER_UTILS_EXPORT void	Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
SOLVER_UTILS_EXPORT void	Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
SOLVER_UTILS_EXPORT void	Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
SOLVER_UTILS_EXPORT bool	IsTimeDependent ()

Additional Inherited Members
Public Types inherited from Nektar::SolverUtils::Filter
typedef std::map< std::string, std::string >	ParamMap
virtual void	v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
virtual void	v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
virtual void	v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
virtual bool	v_IsTimeDependent ()=0
Protected Attributes inherited from Nektar::SolverUtils::Filter
LibUtilities::SessionReaderSharedPtr	m_session
const std::weak_ptr< EquationSystem >	m_equ

Detailed Description

Filter wrapper to handle virtual function calls in Filter and its subclasses.

Definition at line 47 of file Python/Filter.cpp.

Constructor & Destructor Documentation

FilterWrap()

FilterWrap::FilterWrap ( LibUtilities::SessionReaderSharedPtr  session, std::shared_ptr< EquationSystem >  eqn  )

inline

Constructor, which is identical to Filter.

Parameters

field

Input field.

Definition at line 54 of file Python/Filter.cpp.

        : Filter(session, eqn), py::wrapper<Filter>()
    {
    }

Member Function Documentation

ArrayOneDToPyList()

py::list FilterWrap::ArrayOneDToPyList ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields )

inline

Definition at line 60 of file Python/Filter.cpp.

    {
        py::list expLists;
 
        for (int i = 0; i < pFields.size(); ++i)
        {
            expLists.append(py::object(pFields[i]));
        }
 
        return expLists;
    }

Referenced by v_Finalise(), v_Initialise(), and v_Update().

v_Finalise()

void FilterWrap::v_Finalise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields, const NekDouble &  time  )

inlineoverridevirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 87 of file Python/Filter.cpp.

    {
        this->get_override("Finalise")(ArrayOneDToPyList(pFields), time);
    }

References ArrayOneDToPyList().

v_Initialise()

void FilterWrap::v_Initialise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields, const NekDouble &  time  )

inlineoverridevirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 73 of file Python/Filter.cpp.

    {
        this->get_override("Initialise")(ArrayOneDToPyList(pFields), time);
    }

References ArrayOneDToPyList().

v_IsTimeDependent()

bool FilterWrap::v_IsTimeDependent ( )

inlineoverridevirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 94 of file Python/Filter.cpp.

    {
        return this->get_override("IsTimeDependent")();
    }

v_Update()

void FilterWrap::v_Update ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields, const NekDouble &  time  )

inlineoverridevirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 80 of file Python/Filter.cpp.

    {
        this->get_override("Update")(ArrayOneDToPyList(pFields), time);
    }

References ArrayOneDToPyList().