Nektar::SolverUtils::Filter Class Reference

#include <Filter.h>

Inheritance diagram for Nektar::SolverUtils::Filter:

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.

                                                                 :
    m_session(pSession)
{
}

Nektar::SolverUtils::Filter::~Filter ( )

virtual

Definition at line 57 of file Filter.cpp.

{
}

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().

{
    v_Finalise(pFields, time);
}

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().

{
    v_Initialise(pFields, time);
}

bool Nektar::SolverUtils::Filter::IsTimeDependent ( void  )

inline

Definition at line 119 of file Filter.h.

References v_IsTimeDependent().

{
    return v_IsTimeDependent();
}

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().

{
    v_Update(pFields, time);
}

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

protectedpure virtual

Implemented in Nektar::FilterMovingBody, Nektar::SolverUtils::FilterModalEnergy, Nektar::SolverUtils::FilterAeroForces, Nektar::SolverUtils::FilterEnergy1D, Nektar::FilterBenchmark, Nektar::FilterCheckpointCellModel, Nektar::SolverUtils::FilterThresholdMin, Nektar::FilterElectrogram, Nektar::SolverUtils::FilterThresholdMax, Nektar::SolverUtils::FilterCheckpoint, Nektar::SolverUtils::FilterHistoryPoints, Nektar::SolverUtils::FilterSampler, and Nektar::SolverUtils::FilterEnergyBase.

Referenced by Finalise().

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

protectedpure virtual

Implemented in Nektar::SolverUtils::FilterModalEnergy, Nektar::SolverUtils::FilterAeroForces, Nektar::SolverUtils::FilterEnergy1D, Nektar::FilterCheckpointCellModel, Nektar::FilterBenchmark, Nektar::SolverUtils::FilterThresholdMin, Nektar::FilterElectrogram, Nektar::FilterMovingBody, Nektar::SolverUtils::FilterMovingAverage, Nektar::SolverUtils::FilterThresholdMax, Nektar::SolverUtils::FilterReynoldsStresses, Nektar::SolverUtils::FilterAverageFields, Nektar::SolverUtils::FilterCheckpoint, Nektar::SolverUtils::FilterHistoryPoints, Nektar::SolverUtils::FilterSampler, and Nektar::SolverUtils::FilterEnergyBase.

Referenced by Initialise().

virtual bool Nektar::SolverUtils::Filter::v_IsTimeDependent ( )

protectedpure virtual

Implemented in Nektar::FilterMovingBody, Nektar::SolverUtils::FilterModalEnergy, Nektar::SolverUtils::FilterAeroForces, Nektar::SolverUtils::FilterEnergy1D, Nektar::FilterBenchmark, Nektar::SolverUtils::FilterThresholdMin, Nektar::FilterCheckpointCellModel, Nektar::FilterElectrogram, Nektar::SolverUtils::FilterThresholdMax, Nektar::SolverUtils::FilterCheckpoint, Nektar::SolverUtils::FilterHistoryPoints, Nektar::SolverUtils::FilterMovingAverage, Nektar::SolverUtils::FilterReynoldsStresses, Nektar::SolverUtils::FilterAverageFields, and Nektar::SolverUtils::FilterEnergyBase.

Referenced by IsTimeDependent().

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

protectedpure virtual

Implemented in Nektar::SolverUtils::FilterModalEnergy, Nektar::SolverUtils::FilterAeroForces, Nektar::SolverUtils::FilterEnergy1D, Nektar::FilterCheckpointCellModel, Nektar::FilterBenchmark, Nektar::SolverUtils::FilterThresholdMin, Nektar::FilterElectrogram, Nektar::FilterMovingBody, Nektar::SolverUtils::FilterThresholdMax, Nektar::FilterCellHistoryPoints, Nektar::SolverUtils::FilterCheckpoint, Nektar::SolverUtils::FilterHistoryPoints, Nektar::SolverUtils::FilterSampler, and Nektar::SolverUtils::FilterEnergyBase.

Referenced by Update().

Member Data Documentation

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

protected

Definition at line 84 of file Filter.h.

Referenced by Nektar::SolverUtils::FilterAeroForces::CalculateForces(), Nektar::SolverUtils::FilterAeroForces::CalculateForcesMapping(), Nektar::SolverUtils::FilterAeroForces::FilterAeroForces(), Nektar::FilterBenchmark::FilterBenchmark(), Nektar::SolverUtils::FilterCheckpoint::FilterCheckpoint(), Nektar::FilterCheckpointCellModel::FilterCheckpointCellModel(), Nektar::FilterElectrogram::FilterElectrogram(), Nektar::SolverUtils::FilterEnergy1D::FilterEnergy1D(), Nektar::SolverUtils::FilterEnergyBase::FilterEnergyBase(), Nektar::SolverUtils::FilterHistoryPoints::FilterHistoryPoints(), Nektar::SolverUtils::FilterModalEnergy::FilterModalEnergy(), Nektar::SolverUtils::FilterMovingAverage::FilterMovingAverage(), Nektar::SolverUtils::FilterReynoldsStresses::FilterReynoldsStresses(), Nektar::SolverUtils::FilterSampler::FilterSampler(), Nektar::SolverUtils::FilterThresholdMax::FilterThresholdMax(), Nektar::SolverUtils::FilterThresholdMin::FilterThresholdMin(), Nektar::SolverUtils::FilterModalEnergy::ImportFldBase(), Nektar::SolverUtils::FilterModalEnergy::SetUpBaseFields(), Nektar::SolverUtils::FilterHistoryPoints::v_Initialise(), Nektar::FilterElectrogram::v_Initialise(), Nektar::SolverUtils::FilterAeroForces::v_Initialise(), Nektar::SolverUtils::FilterCheckpoint::v_Update(), Nektar::SolverUtils::FilterAeroForces::v_Update(), and Nektar::SolverUtils::FilterModalEnergy::v_Update().