Nektar::SolverUtils::FilterAverageFields Class Reference

#include <FilterAverageFields.h>

Inheritance diagram for Nektar::SolverUtils::FilterAverageFields:

Collaboration diagram for Nektar::SolverUtils::FilterAverageFields:

Public Member Functions
SOLVER_UTILS_EXPORT	FilterAverageFields (const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
virtual SOLVER_UTILS_EXPORT	~FilterAverageFields ()
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 void	v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
virtual void	v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
virtual bool	v_IsTimeDependent ()
void	OutputAvgField (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, int dump=-1)

Private Attributes
unsigned int	m_numAverages
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_avgFieldMetaData
Array< OneD, Array< OneD, NekDouble > >	m_avgFields

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::Filter
LibUtilities::SessionReaderSharedPtr	m_session

Detailed Description

Definition at line 45 of file FilterAverageFields.h.

Constructor & Destructor Documentation

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

Definition at line 46 of file FilterAverageFields.cpp.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), ASSERTL0, Nektar::LibUtilities::Equation::Evaluate(), m_fld, m_index, m_numAverages, m_outputFile, m_outputFrequency, m_outputIndex, m_sampleFrequency, 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_numAverages = 0;
    m_index       = 0;
    m_outputIndex = 0;
    m_fld = MemoryManager<LibUtilities::FieldIO>
                ::AllocateSharedPtr(pSession->GetComm());

}

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

virtual

Definition at line 97 of file FilterAverageFields.cpp.

{
}

Member Function Documentation

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

inlinestatic

Creates an instance of this class.

Definition at line 51 of file FilterAverageFields.h.

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

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

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

protected

Definition at line 152 of file FilterAverageFields.cpp.

References m_avgFieldMetaData, m_avgFields, m_fld, m_numAverages, m_outputFile, Nektar::SolverUtils::Filter::m_session, and Vmath::Smul().

Referenced by v_Finalise(), and v_Update().

{
    for(int n = 0; n < m_avgFields.num_elements(); ++n)
    {
        Vmath::Smul(m_avgFields[n].num_elements(), 1.0/m_numAverages,
                    m_avgFields[n], 1,
                    m_avgFields[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 < pFields.num_elements(); ++j)
    {
        // check to see if field is same order a zeroth field
        if(m_avgFields[j].num_elements() == ncoeffs)
        {
            fieldcoeffs = m_avgFields[j];
        }
        else
        {
            fieldcoeffs = Array<OneD,NekDouble>(ncoeffs);
            pFields[0]->ExtractCoeffsToCoeffs(pFields[j],
                                              m_avgFields[j],
                                              fieldcoeffs);
        }

        for(int i = 0; i < FieldDef.size(); ++i)
        {
            // Could do a search here to find correct variable
            FieldDef[i]->m_fields.push_back(m_session->GetVariable(j));
            pFields[0]->AppendFieldData(FieldDef[i],
                                        FieldData[i],
                                        fieldcoeffs);
        }
    }

    m_avgFieldMetaData["NumberOfFieldDumps"]
                      = boost::lexical_cast<std::string>(m_numAverages);

    std::stringstream outname;
    if(dump == -1) // final dump
    {
        outname <<  m_outputFile << "_avg.fld";
    }
    else
    {
        outname << m_outputFile<< "_" << dump << "_avg.fld";
    }

    m_fld->Write(outname.str(),FieldDef,FieldData,m_avgFieldMetaData);

    if(dump != -1) // not final dump so rescale cummulative average
    {
        for(int n = 0; n < m_avgFields.num_elements(); ++n)
        {
            Vmath::Smul(m_avgFields[n].num_elements(),
                        (NekDouble) m_numAverages,
                        m_avgFields[n], 1,
                        m_avgFields[n], 1);
        }
    }
}

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

protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 145 of file FilterAverageFields.cpp.

References OutputAvgField().

{
    OutputAvgField(pFields);
}

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

protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 101 of file FilterAverageFields.cpp.

References m_avgFieldMetaData, and m_avgFields.

{
    int nfield = pFields.num_elements();
    int ncoeff = pFields[0]->GetNcoeffs();
    m_avgFields = Array<OneD, Array<OneD, NekDouble> >(nfield);
    for(int n =0; n < nfield; ++n)
    {
        m_avgFields[n] = Array<OneD, NekDouble>(ncoeff, 0.0);
    }
    m_avgFieldMetaData["InitialTime"]
                       = boost::lexical_cast<std::string>(time);
}

bool Nektar::SolverUtils::FilterAverageFields::v_IsTimeDependent ( )

protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 223 of file FilterAverageFields.cpp.

{
    return true;
}

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

protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 116 of file FilterAverageFields.cpp.

References m_avgFieldMetaData, m_avgFields, m_index, m_numAverages, m_outputFrequency, m_outputIndex, m_sampleFrequency, OutputAvgField(), and Vmath::Vadd().

{
    m_index++;
    if (m_index % m_sampleFrequency > 0)
    {
        return;
    }

    for(int n = 0; n < pFields.num_elements(); ++n)
    {
        Vmath::Vadd(m_avgFields[n].num_elements(),
                    pFields[n]->GetCoeffs(),1,m_avgFields[n],1,
                    m_avgFields[n],1);
    }
    m_numAverages += 1;

    // update FinalTime here since this is when last field will be added.
    m_avgFieldMetaData["FinalTime"]
                       = boost::lexical_cast<std::string>(time);

    if (m_index % m_outputFrequency == 0)
    {
        OutputAvgField(pFields,++m_outputIndex);
    }

}

Friends And Related Function Documentation

friend class MemoryManager< FilterAverageFields >

friend

Definition at line 48 of file FilterAverageFields.h.

Member Data Documentation

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.

LibUtilities::FieldMetaDataMap Nektar::SolverUtils::FilterAverageFields::m_avgFieldMetaData

private

Definition at line 91 of file FilterAverageFields.h.

Referenced by OutputAvgField(), v_Initialise(), and v_Update().

Array<OneD, Array<OneD, NekDouble> > Nektar::SolverUtils::FilterAverageFields::m_avgFields

private

Definition at line 92 of file FilterAverageFields.h.

Referenced by OutputAvgField(), v_Initialise(), and v_Update().

LibUtilities::FieldIOSharedPtr Nektar::SolverUtils::FilterAverageFields::m_fld

private

Definition at line 90 of file FilterAverageFields.h.

Referenced by FilterAverageFields(), and OutputAvgField().

unsigned int Nektar::SolverUtils::FilterAverageFields::m_index

private

Definition at line 87 of file FilterAverageFields.h.

Referenced by FilterAverageFields(), and v_Update().

unsigned int Nektar::SolverUtils::FilterAverageFields::m_numAverages

private

Definition at line 84 of file FilterAverageFields.h.

Referenced by FilterAverageFields(), OutputAvgField(), and v_Update().

std::string Nektar::SolverUtils::FilterAverageFields::m_outputFile

private

Definition at line 89 of file FilterAverageFields.h.

Referenced by FilterAverageFields(), and OutputAvgField().

unsigned int Nektar::SolverUtils::FilterAverageFields::m_outputFrequency

private

Definition at line 85 of file FilterAverageFields.h.

Referenced by FilterAverageFields(), and v_Update().

unsigned int Nektar::SolverUtils::FilterAverageFields::m_outputIndex

private

Definition at line 88 of file FilterAverageFields.h.

Referenced by FilterAverageFields(), and v_Update().

unsigned int Nektar::SolverUtils::FilterAverageFields::m_sampleFrequency

private

Definition at line 86 of file FilterAverageFields.h.

Referenced by FilterAverageFields(), and v_Update().