Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Nektar::SolverUtils::Filter Class Referenceabstract

#include <Filter.h>

Inheritance diagram for Nektar::SolverUtils::Filter:
Inheritance graph
[legend]

Public Types

typedef std::map< std::string,
std::string > 
ParamMap
 

Public Member Functions

SOLVER_UTILS_EXPORT Filter (const LibUtilities::SessionReaderSharedPtr &pSession)
 
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 ()
 

Protected Member Functions

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

LibUtilities::SessionReaderSharedPtr m_session
 

Detailed Description

Definition at line 64 of file Filter.h.

Member Typedef Documentation

typedef std::map<std::string, std::string> Nektar::SolverUtils::Filter::ParamMap

Definition at line 67 of file Filter.h.

Constructor & Destructor Documentation

Nektar::SolverUtils::Filter::Filter ( const LibUtilities::SessionReaderSharedPtr pSession)

Definition at line 52 of file Filter.cpp.

52  :
53  m_session(pSession)
54 {
55 }
LibUtilities::SessionReaderSharedPtr m_session
Definition: Filter.h:84
Nektar::SolverUtils::Filter::~Filter ( )
virtual

Definition at line 57 of file Filter.cpp.

58 {
59 }

Member Function Documentation

void Nektar::SolverUtils::Filter::Finalise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const NekDouble time 
)
inline

Definition at line 112 of file Filter.h.

References v_Finalise().

115 {
116  v_Finalise(pFields, time);
117 }
virtual void v_Finalise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
void Nektar::SolverUtils::Filter::Initialise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const NekDouble time 
)
inline

Definition at line 98 of file Filter.h.

References v_Initialise().

101 {
102  v_Initialise(pFields, time);
103 }
virtual void v_Initialise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
bool Nektar::SolverUtils::Filter::IsTimeDependent ( void  )
inline

Definition at line 119 of file Filter.h.

References v_IsTimeDependent().

120 {
121  return v_IsTimeDependent();
122 }
virtual bool v_IsTimeDependent()=0
void Nektar::SolverUtils::Filter::Update ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const NekDouble time 
)
inline

Definition at line 105 of file Filter.h.

References v_Update().

108 {
109  v_Update(pFields, time);
110 }
virtual void v_Update(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
virtual void Nektar::SolverUtils::Filter::v_Finalise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const NekDouble time 
)
protectedpure virtual
virtual void Nektar::SolverUtils::Filter::v_Initialise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const NekDouble time 
)
protectedpure virtual
virtual bool Nektar::SolverUtils::Filter::v_IsTimeDependent ( )
protectedpure virtual
virtual void Nektar::SolverUtils::Filter::v_Update ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const NekDouble time 
)
protectedpure virtual

Member Data Documentation

LibUtilities::SessionReaderSharedPtr Nektar::SolverUtils::Filter::m_session
protected