Nektar::SolverUtils::FilterMovingAverage Class Reference

#include <FilterMovingAverage.h>

Inheritance diagram for Nektar::SolverUtils::FilterMovingAverage:

Collaboration diagram for Nektar::SolverUtils::FilterMovingAverage:

Public Member Functions
SOLVER_UTILS_EXPORT	FilterMovingAverage (const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
virtual SOLVER_UTILS_EXPORT	~FilterMovingAverage ()
Public Member Functions inherited from Nektar::SolverUtils::FilterSampler
SOLVER_UTILS_EXPORT	FilterSampler (const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
virtual SOLVER_UTILS_EXPORT	~FilterSampler ()
Public Member Functions inherited from Nektar::SolverUtils::Filter
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 ()

Static Public Member Functions
static FilterSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession, const std::map< std::string, std::string > &pParams)
	Creates an instance of this class. More...

Static Public Attributes
static std::string	className
	Name of the class. More...

Protected Member Functions
virtual void	v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
virtual bool	v_IsTimeDependent ()
virtual void	v_ProcessSample (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
virtual std::string	v_GetFileSuffix ()
Protected Member Functions inherited from Nektar::SolverUtils::FilterSampler
virtual SOLVER_UTILS_EXPORT void	v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
virtual SOLVER_UTILS_EXPORT void	v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
virtual SOLVER_UTILS_EXPORT void	v_PrepareOutput (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
void	OutputField (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, int dump=-1)

Protected Attributes
NekDouble	m_alpha
Protected Attributes inherited from Nektar::SolverUtils::FilterSampler
NekDouble	m_scale
unsigned int	m_numSamples
unsigned int	m_outputFrequency
unsigned int	m_sampleFrequency
unsigned int	m_index
unsigned int	m_outputIndex
std::string	m_outputFile
LibUtilities::FieldIOSharedPtr	m_fld
LibUtilities::FieldMetaDataMap	m_fieldMetaData
std::vector< Array< OneD, NekDouble > >	m_outFields
std::vector< std::string >	m_variables
Protected Attributes inherited from Nektar::SolverUtils::Filter
LibUtilities::SessionReaderSharedPtr	m_session

Friends
class	MemoryManager< FilterMovingAverage >

Additional Inherited Members
Public Types inherited from Nektar::SolverUtils::Filter
typedef std::map< std::string, std::string >	ParamMap

Detailed Description

Definition at line 46 of file FilterMovingAverage.h.

Constructor & Destructor Documentation

Nektar::SolverUtils::FilterMovingAverage::FilterMovingAverage	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		const ParamMap &	pParams
	)

Definition at line 47 of file FilterMovingAverage.cpp.

References ASSERTL0, Nektar::LibUtilities::Equation::Evaluate(), m_alpha, Nektar::SolverUtils::FilterSampler::m_sampleFrequency, and Nektar::SolverUtils::Filter::m_session.

    : FilterSampler(pSession, pParams)
{
    ParamMap::const_iterator it;

    // Load filter parameter
    it = pParams.find("alpha");
    if (it == pParams.end())
    {
        it = pParams.find("tau");
        if (it == pParams.end())
        {
            ASSERTL0(false, "FilterMovingAverage needs either alpha or tau.");
        }
        else
        {
            // Load time constant
            LibUtilities::Equation equ(m_session, it->second);
            NekDouble tau = equ.Evaluate();
            // Load delta T between samples
            NekDouble dT;
            m_session->LoadParameter("TimeStep", dT);
            dT = dT * m_sampleFrequency;
            // Calculate alpha
            m_alpha = dT / (tau + dT);
        }
    }
    else
    {
        LibUtilities::Equation equ(m_session, it->second);
        m_alpha = equ.Evaluate();
        // Check if tau was also defined
        it = pParams.find("tau");
        if (it != pParams.end())
        {
            ASSERTL0(false,
                     "Cannot define both alpha and tau in MovingAverage.");
        }
    }
    // Check bounds of m_alpha
    ASSERTL0(m_alpha > 0 && m_alpha < 1, "Alpha out of bounds.");
}

Nektar::SolverUtils::FilterMovingAverage::~FilterMovingAverage ( )

virtual

Definition at line 92 of file FilterMovingAverage.cpp.

{
}

Member Function Documentation

static FilterSharedPtr Nektar::SolverUtils::FilterMovingAverage::create ( const LibUtilities::SessionReaderSharedPtr &  pSession, const std::map< std::string, std::string > &  pParams  )

inlinestatic

Creates an instance of this class.

Definition at line 52 of file FilterMovingAverage.h.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr().

    {
        FilterSharedPtr p =
            MemoryManager<FilterMovingAverage>::AllocateSharedPtr(pSession,
                                                                  pParams);
        return p;
    }

virtual std::string Nektar::SolverUtils::FilterMovingAverage::v_GetFileSuffix ( )

inlineprotectedvirtual

Implements Nektar::SolverUtils::FilterSampler.

Definition at line 78 of file FilterMovingAverage.h.

    {
        return "_movAvg";
    }

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

protectedvirtual

Reimplemented from Nektar::SolverUtils::FilterSampler.

Definition at line 96 of file FilterMovingAverage.cpp.

References Nektar::SolverUtils::FilterSampler::m_variables, and Nektar::SolverUtils::FilterSampler::v_Initialise().

{
    int nfield = pFields.num_elements();
    m_variables.resize(pFields.num_elements());
    // Fill name of variables
    for (int n = 0; n < nfield; ++n)
    {
        m_variables[n] = pFields[n]->GetSession()->GetVariable(n);
    }
    // Now let FilterSampler initialise the output
    FilterSampler::v_Initialise(pFields, time);
}

bool Nektar::SolverUtils::FilterMovingAverage::v_IsTimeDependent ( )

protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 137 of file FilterMovingAverage.cpp.

{
    return true;
}

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

protectedvirtual

Implements Nektar::SolverUtils::FilterSampler.

Definition at line 111 of file FilterMovingAverage.cpp.

References m_alpha, Nektar::SolverUtils::FilterSampler::m_numSamples, Nektar::SolverUtils::FilterSampler::m_outFields, and Vmath::Svtsvtp().

{
    // Take first sample as initial vector
    NekDouble alpha = m_alpha;
    if (m_numSamples == 1)
    {
        alpha = 1.0;
    }

    // \bar{u}_n = alpha * u_n + (1-alpha) * \bar{u}_{n-1}
    for (int n = 0; n < pFields.num_elements(); ++n)
    {
        Vmath::Svtsvtp(m_outFields[n].num_elements(),
                       alpha,
                       pFields[n]->GetCoeffs(),
                       1,
                       (1.0 - alpha),
                       m_outFields[n],
                       1,
                       m_outFields[n],
                       1);
    }
}

Friends And Related Function Documentation

friend class MemoryManager< FilterMovingAverage >

friend

Definition at line 49 of file FilterMovingAverage.h.

Member Data Documentation

std::string Nektar::SolverUtils::FilterMovingAverage::className

static

Initial value:

=
    GetFilterFactory().RegisterCreatorFunction("MovingAverage",
                                               FilterMovingAverage::create)

Name of the class.

Definition at line 63 of file FilterMovingAverage.h.

NekDouble Nektar::SolverUtils::FilterMovingAverage::m_alpha

protected

Definition at line 83 of file FilterMovingAverage.h.

Referenced by FilterMovingAverage(), and v_ProcessSample().