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, const std::weak_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 ()

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
const std::weak_ptr< EquationSystem >	m_equ

Detailed Description

Definition at line 62 of file Filter.h.

Member Typedef Documentation

ParamMap

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

Definition at line 65 of file Filter.h.

Constructor & Destructor Documentation

Filter()

Nektar::SolverUtils::Filter::Filter	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		const std::weak_ptr< EquationSystem > &	pEquation
	)

Definition at line 45 of file Filter.cpp.

    : m_session(pSession), m_equ(pEquation)
{
}

~Filter()

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

virtual

Definition at line 51 of file Filter.cpp.

{
}

Member Function Documentation

Finalise()

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

inline

Definition at line 112 of file Filter.h.

{
    v_Finalise(pFields, time);
}

References v_Finalise().

Initialise()

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

inline

Definition at line 98 of file Filter.h.

{
    v_Initialise(pFields, time);
}

References v_Initialise().

IsTimeDependent()

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

inline

Definition at line 119 of file Filter.h.

{
    return v_IsTimeDependent();
}

References v_IsTimeDependent().

Update()

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

inline

Definition at line 105 of file Filter.h.

{
    v_Update(pFields, time);
}

References v_Update().

v_Finalise()

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

protectedpure virtual

Implemented in Nektar::SolverUtils::FilterEnergy, Nektar::SolverUtils::FilterEnergy1D, Nektar::SolverUtils::FilterMean, Nektar::SolverUtils::FilterError, Nektar::SolverUtils::FilterIntegral, Nektar::SolverUtils::FilterAeroForces, Nektar::SolverUtils::FilterCheckpoint, Nektar::SolverUtils::FilterFieldConvert, Nektar::SolverUtils::FilterHistoryPoints, Nektar::SolverUtils::FilterLagrangianPoints, Nektar::SolverUtils::FilterModalEnergy, Nektar::SolverUtils::FilterThresholdMax, Nektar::SolverUtils::FilterThresholdMin, Nektar::FilterBenchmark, Nektar::FilterCheckpointCellModel, Nektar::FilterElectrogram, Nektar::FilterHilbertFFTPhase, Nektar::FilterOffsetPhase, Nektar::FilterAeroForcesSPM, and Nektar::FilterMovingBody.

Referenced by Finalise().

v_Initialise()

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

protectedpure virtual

Implemented in Nektar::SolverUtils::FilterEnergy, Nektar::SolverUtils::FilterEnergy1D, Nektar::SolverUtils::FilterMean, Nektar::SolverUtils::FilterError, Nektar::SolverUtils::FilterIntegral, Nektar::SolverUtils::FilterAeroForces, Nektar::SolverUtils::FilterBodyFittedVelocity, Nektar::SolverUtils::FilterCheckpoint, Nektar::SolverUtils::FilterFieldConvert, Nektar::SolverUtils::FilterHistoryPoints, Nektar::SolverUtils::FilterLagrangianPoints, Nektar::SolverUtils::FilterMaxMinFields, Nektar::SolverUtils::FilterModalEnergy, Nektar::SolverUtils::FilterThresholdMax, Nektar::SolverUtils::FilterThresholdMin, Nektar::FilterBenchmark, Nektar::FilterCheckpointCellModel, Nektar::FilterElectrogram, Nektar::FilterHilbertFFTPhase, Nektar::FilterOffsetPhase, Nektar::FilterAeroForcesSPM, Nektar::FilterMovingBody, and Nektar::SolverUtils::FilterReynoldsStresses.

Referenced by Initialise().

v_IsTimeDependent()

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

protectedpure virtual

Implemented in Nektar::SolverUtils::FilterError, Nektar::SolverUtils::FilterIntegral, Nektar::SolverUtils::FilterAeroForces, Nektar::SolverUtils::FilterCheckpoint, Nektar::SolverUtils::FilterEnergy, Nektar::SolverUtils::FilterEnergy1D, Nektar::SolverUtils::FilterFieldConvert, Nektar::SolverUtils::FilterHistoryPoints, Nektar::SolverUtils::FilterLagrangianPoints, Nektar::SolverUtils::FilterMean, Nektar::SolverUtils::FilterModalEnergy, Nektar::SolverUtils::FilterThresholdMax, Nektar::SolverUtils::FilterThresholdMin, Nektar::FilterBenchmark, Nektar::FilterCheckpointCellModel, Nektar::FilterElectrogram, Nektar::FilterHilbertFFTPhase, Nektar::FilterOffsetPhase, Nektar::FilterAeroForcesSPM, and Nektar::FilterMovingBody.

Referenced by IsTimeDependent().

v_Update()

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

protectedpure virtual

Implemented in Nektar::SolverUtils::FilterEnergy, Nektar::SolverUtils::FilterEnergy1D, Nektar::SolverUtils::FilterMean, Nektar::SolverUtils::FilterError, Nektar::SolverUtils::FilterIntegral, Nektar::SolverUtils::FilterAeroForces, Nektar::SolverUtils::FilterCheckpoint, Nektar::SolverUtils::FilterFieldConvert, Nektar::SolverUtils::FilterHistoryPoints, Nektar::SolverUtils::FilterLagrangianPoints, Nektar::SolverUtils::FilterModalEnergy, Nektar::SolverUtils::FilterThresholdMax, Nektar::SolverUtils::FilterThresholdMin, Nektar::FilterBenchmark, Nektar::FilterCellHistoryPoints, Nektar::FilterCheckpointCellModel, Nektar::FilterElectrogram, Nektar::FilterHilbertFFTPhase, Nektar::FilterOffsetPhase, Nektar::FilterAeroForcesSPM, and Nektar::FilterMovingBody.

Referenced by Update().

Member Data Documentation

m_equ

const std::weak_ptr<EquationSystem> Nektar::SolverUtils::Filter::m_equ

protected

Definition at line 84 of file Filter.h.

Referenced by Nektar::SolverUtils::FilterAeroForces::CalculateForces(), Nektar::SolverUtils::FilterError::FilterError(), Nektar::SolverUtils::FilterIntegral::FilterIntegral(), Nektar::SolverUtils::FilterFieldConvert::v_FillVariablesName(), Nektar::SolverUtils::FilterMean::v_Initialise(), Nektar::SolverUtils::FilterEnergy::v_Update(), Nektar::SolverUtils::FilterError::v_Update(), and Nektar::SolverUtils::FilterFieldConvert::v_Update().

m_session

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

protected

Definition at line 83 of file Filter.h.

Referenced by Nektar::SolverUtils::FilterAeroForces::CalculateForces(), Nektar::SolverUtils::FilterAeroForces::CalculateForcesMapping(), Nektar::SolverUtils::FilterFieldConvert::CreateFields(), Nektar::SolverUtils::FilterAeroForces::FilterAeroForces(), Nektar::FilterAeroForcesSPM::FilterAeroForcesSPM(), Nektar::SolverUtils::FilterAverageFields::FilterAverageFields(), Nektar::FilterBenchmark::FilterBenchmark(), Nektar::SolverUtils::FilterBodyFittedVelocity::FilterBodyFittedVelocity(), Nektar::SolverUtils::FilterCheckpoint::FilterCheckpoint(), Nektar::FilterCheckpointCellModel::FilterCheckpointCellModel(), Nektar::FilterElectrogram::FilterElectrogram(), Nektar::SolverUtils::FilterEnergy::FilterEnergy(), Nektar::SolverUtils::FilterEnergy1D::FilterEnergy1D(), Nektar::SolverUtils::FilterError::FilterError(), Nektar::SolverUtils::FilterFieldConvert::FilterFieldConvert(), Nektar::FilterHilbertFFTPhase::FilterHilbertFFTPhase(), Nektar::SolverUtils::FilterHistoryPoints::FilterHistoryPoints(), Nektar::SolverUtils::FilterIntegral::FilterIntegral(), Nektar::SolverUtils::FilterMaxMinFields::FilterMaxMinFields(), Nektar::SolverUtils::FilterMean::FilterMean(), Nektar::SolverUtils::FilterModalEnergy::FilterModalEnergy(), Nektar::SolverUtils::FilterMovingAverage::FilterMovingAverage(), Nektar::FilterMovingBody::FilterMovingBody(), Nektar::FilterOffsetPhase::FilterOffsetPhase(), Nektar::SolverUtils::FilterReynoldsStresses::FilterReynoldsStresses(), Nektar::SolverUtils::FilterThresholdMax::FilterThresholdMax(), Nektar::SolverUtils::FilterThresholdMin::FilterThresholdMin(), Nektar::SolverUtils::FilterModalEnergy::ImportFldBase(), Nektar::SolverUtils::FilterModalEnergy::SetUpBaseFields(), Nektar::FilterMovingBody::UpdateMotion(), Nektar::SolverUtils::FilterAeroForces::v_Initialise(), Nektar::SolverUtils::FilterBodyFittedVelocity::v_Initialise(), Nektar::SolverUtils::FilterFieldConvert::v_Initialise(), Nektar::SolverUtils::FilterHistoryPoints::v_Initialise(), Nektar::SolverUtils::FilterLagrangianPoints::v_Initialise(), Nektar::SolverUtils::FilterModalEnergy::v_Initialise(), Nektar::FilterElectrogram::v_Initialise(), Nektar::FilterAeroForcesSPM::v_Initialise(), Nektar::FilterMovingBody::v_Initialise(), Nektar::SolverUtils::FilterAeroForces::v_Update(), Nektar::SolverUtils::FilterCheckpoint::v_Update(), Nektar::SolverUtils::FilterFieldConvert::v_Update(), Nektar::SolverUtils::FilterModalEnergy::v_Update(), and Nektar::SolverUtils::FilterHistoryPoints::v_WriteData().