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::FilterFieldConvert
SOLVER_UTILS_EXPORT	FilterFieldConvert (const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
virtual SOLVER_UTILS_EXPORT	~FilterFieldConvert ()
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 Member Functions inherited from Nektar::SolverUtils::FilterFieldConvert
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...
Static Public Attributes inherited from Nektar::SolverUtils::FilterFieldConvert
static std::string	className
	Name of the class. More...

Protected Member Functions
virtual void	v_ProcessSample (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
virtual void	v_PrepareOutput (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
virtual NekDouble	v_GetScale ()
virtual std::string	v_GetFileSuffix ()
Protected Member Functions inherited from Nektar::SolverUtils::FilterFieldConvert
virtual SOLVER_UTILS_EXPORT void	v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
virtual SOLVER_UTILS_EXPORT void	v_FillVariablesName (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields)
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)
void	OutputField (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, int dump=-1)
virtual SOLVER_UTILS_EXPORT bool	v_IsTimeDependent ()
void	CreateModules (vector< string > &modcmds)
void	CreateFields (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields)
void	ClearFields ()

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
vector< ModuleSharedPtr >	m_modules
LibUtilities::FieldMetaDataMap	m_fieldMetaData
std::vector< Array< OneD, NekDouble > >	m_outFields
std::vector< std::string >	m_variables
FieldSharedPtr	m_f
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.

    : FilterFieldConvert(pSession, pParams)
{
}

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

virtual

Definition at line 53 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(), and CellMLToNektar.cellml_metadata::p.

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

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

inlineprotectedvirtual

Reimplemented from Nektar::SolverUtils::FilterFieldConvert.

Definition at line 76 of file FilterAverageFields.h.

    {
        return "_avg";
    }

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

protectedvirtual

Reimplemented from Nektar::SolverUtils::FilterFieldConvert.

Definition at line 81 of file FilterAverageFields.cpp.

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

{
    return 1.0 / m_numSamples;
}

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

protectedvirtual

Reimplemented from Nektar::SolverUtils::FilterFieldConvert.

Definition at line 73 of file FilterAverageFields.cpp.

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

{
    m_fieldMetaData["NumberOfFieldDumps"] =
        boost::lexical_cast<std::string>(m_numSamples);
}

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

protectedvirtual

Reimplemented from Nektar::SolverUtils::FilterFieldConvert.

Definition at line 57 of file FilterAverageFields.cpp.

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

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

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 61 of file FilterAverageFields.h.