Nektar++
Public Member Functions | List of all members
FilterWrap Struct Reference

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

Inheritance diagram for FilterWrap:
[legend]

Public Member Functions

 FilterWrap (LibUtilities::SessionReaderSharedPtr session, std::shared_ptr< EquationSystem > eqn)
 Constructor, which is identical to Filter. More...
 
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 ()
 
SOLVER_UTILS_EXPORT std::string SetupOutput (const std::string ext, const ParamMap &pParams)
 
SOLVER_UTILS_EXPORT std::string SetupOutput (const std::string ext, const std::string inname)
 
SOLVER_UTILS_EXPORT void SetUpdateOnInitialise (bool flag)
 

Additional Inherited Members

- Public Types inherited from Nektar::SolverUtils::Filter
typedef std::map< std::string, std::string > ParamMap
 
- Protected Member Functions inherited from Nektar::SolverUtils::Filter
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
 
virtual SOLVER_UTILS_EXPORT std::string v_SetupOutput (const std::string ext, const ParamMap &pParams)
 
virtual SOLVER_UTILS_EXPORT std::string v_SetupOutput (const std::string ext, const std::string inname)
 
- Protected Attributes inherited from Nektar::SolverUtils::Filter
LibUtilities::SessionReaderSharedPtr m_session
 
const std::weak_ptr< EquationSystemm_equ
 
bool m_updateOnInitialise = true
 

Detailed Description

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

Definition at line 50 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
fieldInput field.

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

59 : Filter(session, eqn)
60 {
61 }
SOLVER_UTILS_EXPORT Filter(const LibUtilities::SessionReaderSharedPtr &pSession, const std::shared_ptr< EquationSystem > &pEquation)

Member Function Documentation

◆ v_Finalise()

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

Implements Nektar::SolverUtils::Filter.

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

82 {
83 PYBIND11_OVERRIDE_PURE_NAME(void, Filter, "Finalise", v_Finalise,
84 pFields, time);
85 }
void v_Finalise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override

References v_Finalise().

Referenced by v_Finalise().

◆ v_Initialise()

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

Implements Nektar::SolverUtils::Filter.

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

66 {
67 PYBIND11_OVERRIDE_PURE_NAME(void, Filter, "Initialise", v_Initialise,
68 pFields, time);
69 }
void v_Initialise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override

References v_Initialise().

Referenced by v_Initialise().

◆ v_IsTimeDependent()

bool FilterWrap::v_IsTimeDependent ( )
inlineoverridevirtual

Implements Nektar::SolverUtils::Filter.

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

88 {
89 PYBIND11_OVERRIDE_PURE_NAME(bool, Filter, "IsTimeDependent",
91 }
bool v_IsTimeDependent() override

References v_IsTimeDependent().

Referenced by v_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 71 of file Python/Filter.cpp.

74 {
75 PYBIND11_OVERRIDE_PURE_NAME(void, Filter, "Update", v_Update, pFields,
76 time);
77 }
void v_Update(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override

References v_Update().

Referenced by v_Update().