#include <FilterAverageFields.h>

Inheritance diagram for Nektar::SolverUtils::FilterAverageFields:

Public Member Functions
SOLVER_UTILS_EXPORT	FilterAverageFields (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation, const ParamMap &pParams)

SOLVER_UTILS_EXPORT	~FilterAverageFields () override

Public Member Functions inherited from Nektar::SolverUtils::FilterFieldConvert
SOLVER_UTILS_EXPORT	FilterFieldConvert (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation, const ParamMap &pParams)

SOLVER_UTILS_EXPORT	~FilterFieldConvert () override

Public Member Functions inherited from Nektar::SolverUtils::Filter
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 ()

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

Static Public Member Functions inherited from Nektar::SolverUtils::FilterFieldConvert
static FilterSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation, 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...

Static Public Attributes inherited from Nektar::SolverUtils::FilterFieldConvert
static std::string	className
	Name of the class. More...

Protected Member Functions
void	v_ProcessSample (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, std::vector< Array< OneD, NekDouble > > &fieldcoeffs, const NekDouble &time) override

void	v_PrepareOutput (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override

NekDouble	v_GetScale () override

std::string	v_GetFileSuffix () override

void	v_FillVariablesName (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields) override

Protected Member Functions inherited from Nektar::SolverUtils::FilterFieldConvert
SOLVER_UTILS_EXPORT void	v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override

virtual SOLVER_UTILS_EXPORT void	v_FillVariablesName (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields)

SOLVER_UTILS_EXPORT void	v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override

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

virtual SOLVER_UTILS_EXPORT void	v_ProcessSample (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, std::vector< Array< OneD, NekDouble > > &fieldcoeffs, const NekDouble &time)

virtual SOLVER_UTILS_EXPORT void	v_PrepareOutput (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)

virtual SOLVER_UTILS_EXPORT NekDouble	v_GetScale ()

virtual SOLVER_UTILS_EXPORT std::string	v_GetFileSuffix ()

void	OutputField (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, int dump=-1)

SOLVER_UTILS_EXPORT bool	v_IsTimeDependent () override

void	CreateModules (std::vector< std::string > &modcmds)

void	CreateFields (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields)

void	CheckModules (std::vector< ModuleSharedPtr > &modules)

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

Friends
class	MemoryManager< FilterAverageFields >

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

Protected Attributes inherited from Nektar::SolverUtils::FilterFieldConvert
unsigned int	m_numSamples

unsigned int	m_outputFrequency

unsigned int	m_sampleFrequency

std::string	m_outputFile

std::string	m_restartFile

unsigned int	m_index

unsigned int	m_outputIndex

bool	m_phaseSample

NekDouble	m_phaseSamplePeriod

NekDouble	m_phaseSamplePhase

NekDouble	m_phaseTolerance

NekDouble	m_dt

std::vector< ModuleSharedPtr >	m_modules

LibUtilities::FieldMetaDataMap	m_fieldMetaData

std::vector< Array< OneD, NekDouble > >	m_outFields

std::vector< std::string >	m_variables

FieldSharedPtr	m_f

po::variables_map	m_vm

Protected Attributes inherited from Nektar::SolverUtils::Filter
LibUtilities::SessionReaderSharedPtr	m_session

const std::weak_ptr< EquationSystem >	m_equ

Detailed Description

Definition at line 42 of file FilterAverageFields.h.

Constructor & Destructor Documentation

◆ FilterAverageFields()

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

Definition at line 43 of file FilterAverageFields.cpp.

    : FilterFieldConvert(pSession, pEquation, pParams)
{
    // Load sampling frequency
    auto it = pParams.find("SampleFrequency");
    if (it == pParams.end())
    {
        m_sampleFrequency = 1;
    }
    else
    {
        LibUtilities::Equation equ(m_session->GetInterpreter(), it->second);
        m_sampleFrequency = round(equ.Evaluate());
    }
}

References Nektar::LibUtilities::Equation::Evaluate(), Nektar::SolverUtils::FilterFieldConvert::m_sampleFrequency, and Nektar::SolverUtils::Filter::m_session.

◆ ~FilterAverageFields()

Nektar::SolverUtils::FilterAverageFields::~FilterAverageFields ( )

override

Definition at line 61 of file FilterAverageFields.cpp.

62{

63}

Member Function Documentation

◆ create()

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

inlinestatic

Creates an instance of this class.

Definition at line 48 of file FilterAverageFields.h.

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

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), and CellMLToNektar.cellml_metadata::p.

◆ v_FillVariablesName()

void Nektar::SolverUtils::FilterAverageFields::v_FillVariablesName ( const Array< OneD, const MultiRegions::ExpListSharedPtr > & pFields )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::SolverUtils::FilterFieldConvert.

Definition at line 81 of file FilterAverageFields.h.

    {
        FilterFieldConvert::v_FillVariablesName(pFields);
    }

References Nektar::SolverUtils::FilterFieldConvert::v_FillVariablesName().

◆ v_GetFileSuffix()

std::string Nektar::SolverUtils::FilterAverageFields::v_GetFileSuffix ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::SolverUtils::FilterFieldConvert.

Definition at line 77 of file FilterAverageFields.h.

    {
        return "_avg";
    }

◆ v_GetScale()

NekDouble Nektar::SolverUtils::FilterAverageFields::v_GetScale ( )

overrideprotectedvirtual

Reimplemented from Nektar::SolverUtils::FilterFieldConvert.

Definition at line 86 of file FilterAverageFields.cpp.

{
    return 1.0 / m_numSamples;
}

References Nektar::SolverUtils::FilterFieldConvert::m_numSamples.

◆ v_PrepareOutput()

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

overrideprotectedvirtual

Reimplemented from Nektar::SolverUtils::FilterFieldConvert.

Definition at line 78 of file FilterAverageFields.cpp.

{
    m_fieldMetaData["NumberOfFieldDumps"] = std::to_string(m_numSamples);
}

References Nektar::SolverUtils::FilterFieldConvert::m_fieldMetaData, and Nektar::SolverUtils::FilterFieldConvert::m_numSamples.

◆ v_ProcessSample()

void Nektar::SolverUtils::FilterAverageFields::v_ProcessSample	(	const Array< OneD, const MultiRegions::ExpListSharedPtr > &	pFields,
		std::vector< Array< OneD, NekDouble > > &	fieldcoeffs,
		const NekDouble &	time
	)

overrideprotectedvirtual

Reimplemented from Nektar::SolverUtils::FilterFieldConvert.

Definition at line 65 of file FilterAverageFields.cpp.

{
    for (int n = 0; n < m_outFields.size(); ++n)
    {
        Vmath::Vadd(m_outFields[n].size(), fieldcoeffs[n], 1, m_outFields[n], 1,
                    m_outFields[n], 1);
    }
}

References Nektar::SolverUtils::FilterFieldConvert::m_outFields, and Vmath::Vadd().

Friends And Related Function Documentation

◆ MemoryManager< FilterAverageFields >

friend class MemoryManager< FilterAverageFields >

friend

Definition at line 1 of file FilterAverageFields.h.

Member Data Documentation

◆ className

std::string Nektar::SolverUtils::FilterAverageFields::className

static

Initial value:

=
    GetFilterFactory().RegisterCreatorFunction("AverageFields",
                                               FilterAverageFields::create)

Name of the class.

Definition at line 60 of file FilterAverageFields.h.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FilterAverageFields()

◆ ~FilterAverageFields()

Member Function Documentation

◆ create()

◆ v_FillVariablesName()

◆ v_GetFileSuffix()

◆ v_GetScale()

◆ v_PrepareOutput()

◆ v_ProcessSample()

Friends And Related Function Documentation

◆ MemoryManager< FilterAverageFields >

Member Data Documentation

◆ className