#include <FilterSampler.h>

Inheritance diagram for Nektar::SolverUtils::FilterSampler:

Collaboration diagram for Nektar::SolverUtils::FilterSampler:

Public Member Functions
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 ()

Protected Member Functions
virtual SOLVER_UTILS_EXPORT void	v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)

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_ProcessSample (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0

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

virtual SOLVER_UTILS_EXPORT std::string	v_GetFileSuffix ()=0

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

Protected Member Functions inherited from Nektar::SolverUtils::Filter
virtual bool	v_IsTimeDependent ()=0

Protected Attributes
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< FilterSampler >

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 FilterSampler.h.

Constructor & Destructor Documentation

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

Definition at line 44 of file FilterSampler.cpp.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), ASSERTL0, Nektar::LibUtilities::Equation::Evaluate(), m_fld, m_index, m_numSamples, m_outputFile, m_outputFrequency, m_outputIndex, m_sampleFrequency, m_scale, and Nektar::SolverUtils::Filter::m_session.

     : Filter(pSession)
 {
     ParamMap::const_iterator it;
 
     // OutputFile
     it = pParams.find("OutputFile");
     if (it == pParams.end())
     {
         m_outputFile = m_session->GetSessionName();
     }
     else
     {
         ASSERTL0(it->second.length() > 0, "Missing parameter 'OutputFile'.");
         m_outputFile = it->second;
     }
 
     // SampleFrequency
     it = pParams.find("SampleFrequency");
     if (it == pParams.end())
     {
         m_sampleFrequency = 1;
     }
     else
     {
         LibUtilities::Equation equ(m_session, it->second);
         m_sampleFrequency = floor(equ.Evaluate());
     }
 
     // OutputFrequency
     it = pParams.find("OutputFrequency");
     if (it == pParams.end())
     {
         m_outputFrequency = m_session->GetParameter("NumSteps");
     }
     else
     {
         LibUtilities::Equation equ(m_session, it->second);
         m_outputFrequency = floor(equ.Evaluate());
     }
 
     m_scale       = 1.0;
     m_numSamples  = 0;
     m_index       = 0;
     m_outputIndex = 0;
     m_fld = MemoryManager<LibUtilities::FieldIO>::AllocateSharedPtr(
         pSession->GetComm());
 }

Nektar::SolverUtils::FilterSampler::~FilterSampler ( )

virtual

Definition at line 95 of file FilterSampler.cpp.

96 {

97 }

Member Function Documentation

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

protected

Definition at line 145 of file FilterSampler.cpp.

References m_fieldMetaData, m_fld, m_numSamples, m_outFields, m_outputFile, m_scale, m_variables, Vmath::Smul(), and v_GetFileSuffix().

Referenced by v_Finalise(), and v_Update().

 {
     for (int n = 0; n < m_outFields.size(); ++n)
     {
         Vmath::Smul(m_outFields[n].num_elements(),
                     m_scale,
                     m_outFields[n],
                     1,
                     m_outFields[n],
                     1);
     }
 
     std::vector<LibUtilities::FieldDefinitionsSharedPtr> FieldDef =
         pFields[0]->GetFieldDefinitions();
     std::vector<std::vector<NekDouble> > FieldData(FieldDef.size());
 
     Array<OneD, NekDouble> fieldcoeffs;
     int ncoeffs = pFields[0]->GetNcoeffs();
 
     // copy Data into FieldData and set variable
     for (int j = 0; j < m_outFields.size(); ++j)
     {
         // check to see if field is same order a zeroth field
         if (m_outFields[j].num_elements() == ncoeffs)
         {
             fieldcoeffs = m_outFields[j];
         }
         else
         {
             fieldcoeffs = Array<OneD, NekDouble>(ncoeffs);
             pFields[0]->ExtractCoeffsToCoeffs(
                 pFields[j], m_outFields[j], fieldcoeffs);
         }
 
         for (int i = 0; i < FieldDef.size(); ++i)
         {
             FieldDef[i]->m_fields.push_back(m_variables[j]);
             pFields[0]->AppendFieldData(FieldDef[i], FieldData[i], fieldcoeffs);
         }
     }
 
     m_fieldMetaData["NumberOfFieldDumps"] =
         boost::lexical_cast<std::string>(m_numSamples);
 
     std::stringstream outname;
     std::string suffix = v_GetFileSuffix();
     if (dump == -1) // final dump
     {
         outname << m_outputFile << suffix << ".fld";
     }
     else
     {
         outname << m_outputFile << "_" << dump << suffix << ".fld";
     }
 
     m_fld->Write(outname.str(), FieldDef, FieldData, m_fieldMetaData);
 
     if (dump != -1) // not final dump so rescale
     {
         for (int n = 0; n < m_outFields.size(); ++n)
         {
             Vmath::Smul(m_outFields[n].num_elements(),
                         1.0 / m_scale,
                         m_outFields[n],
                         1,
                         m_outFields[n],
                         1);
         }
     }
 }

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

protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 136 of file FilterSampler.cpp.

References m_fieldMetaData, OutputField(), and v_PrepareOutput().

 {
     m_fieldMetaData["FinalTime"] = boost::lexical_cast<std::string>(time);
     v_PrepareOutput(pFields, time);
     OutputField(pFields);
 }

virtual SOLVER_UTILS_EXPORT std::string Nektar::SolverUtils::FilterSampler::v_GetFileSuffix ( )

protectedpure virtual

Implemented in Nektar::SolverUtils::FilterReynoldsStresses, Nektar::SolverUtils::FilterAverageFields, and Nektar::SolverUtils::FilterMovingAverage.

Referenced by OutputField().

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

protectedvirtual

Implements Nektar::SolverUtils::Filter.

Reimplemented in Nektar::SolverUtils::FilterMovingAverage, Nektar::SolverUtils::FilterReynoldsStresses, and Nektar::SolverUtils::FilterAverageFields.

Definition at line 99 of file FilterSampler.cpp.

References m_fieldMetaData, m_outFields, and m_variables.

Referenced by Nektar::SolverUtils::FilterAverageFields::v_Initialise(), Nektar::SolverUtils::FilterReynoldsStresses::v_Initialise(), and Nektar::SolverUtils::FilterMovingAverage::v_Initialise().

 {
     int ncoeff = pFields[0]->GetNcoeffs();
     // m_variables need to be filled by a derived class
     m_outFields.resize(m_variables.size());
 
     for (int n = 0; n < m_variables.size(); ++n)
     {
         m_outFields[n] = Array<OneD, NekDouble>(ncoeff, 0.0);
     }
 
     m_fieldMetaData["InitialTime"] = boost::lexical_cast<std::string>(time);
 }

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

inlineprotectedvirtual

Reimplemented in Nektar::SolverUtils::FilterReynoldsStresses, and Nektar::SolverUtils::FilterAverageFields.

Definition at line 69 of file FilterSampler.h.

Referenced by v_Finalise(), and v_Update().

     {
         // Do nothing by default
     }

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

protectedpure virtual

Implemented in Nektar::SolverUtils::FilterMovingAverage, Nektar::SolverUtils::FilterReynoldsStresses, and Nektar::SolverUtils::FilterAverageFields.

Referenced by v_Update().

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

protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 115 of file FilterSampler.cpp.

References m_fieldMetaData, m_index, m_numSamples, m_outputFrequency, m_outputIndex, m_sampleFrequency, OutputField(), v_PrepareOutput(), and v_ProcessSample().

 {
     m_index++;
     if (m_index % m_sampleFrequency > 0)
     {
         return;
     }
 
     m_numSamples++;
     v_ProcessSample(pFields, time);
 
     if (m_index % m_outputFrequency == 0)
     {
         m_fieldMetaData["FinalTime"] = boost::lexical_cast<std::string>(time);
         v_PrepareOutput(pFields, time);
         OutputField(pFields, ++m_outputIndex);
     }
 }