Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
Nektar::SolverUtils::FilterAverageFields Class Reference

#include <FilterAverageFields.h>

Inheritance diagram for Nektar::SolverUtils::FilterAverageFields:
Inheritance graph
[legend]
Collaboration diagram for Nektar::SolverUtils::FilterAverageFields:
Collaboration graph
[legend]

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::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 void v_PrepareOutput (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)
 
void OutputField (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, int dump=-1)
 

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::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
 

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.

49  : FilterSampler(pSession, pParams)
50 {
51 }
SOLVER_UTILS_EXPORT FilterSampler(const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
Nektar::SolverUtils::FilterAverageFields::~FilterAverageFields ( )
virtual

Definition at line 53 of file FilterAverageFields.cpp.

54 {
55 }

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().

54  {
56  ::AllocateSharedPtr(pSession, pParams);
57  return p;
58  }
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
boost::shared_ptr< Filter > FilterSharedPtr
A shared pointer to a Driver object.
Definition: Filter.h:50
virtual std::string Nektar::SolverUtils::FilterAverageFields::v_GetFileSuffix ( )
inlineprotectedvirtual

Implements Nektar::SolverUtils::FilterSampler.

Definition at line 79 of file FilterAverageFields.h.

80  {
81  return "_avg";
82  }
void Nektar::SolverUtils::FilterAverageFields::v_Initialise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const NekDouble time 
)
protectedvirtual

Reimplemented from Nektar::SolverUtils::FilterSampler.

Definition at line 57 of file FilterAverageFields.cpp.

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

60 {
61  int nfield = pFields.num_elements();
62  m_variables.resize(pFields.num_elements());
63  // Fill name of variables
64  for (int n = 0; n < nfield; ++n)
65  {
66  m_variables[n] = pFields[n]->GetSession()->GetVariable(n);
67  }
68  // Now let FilterSampler initialise the output
69  FilterSampler::v_Initialise(pFields, time);
70 }
std::vector< std::string > m_variables
Definition: FilterSampler.h:91
virtual SOLVER_UTILS_EXPORT void v_Initialise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
bool Nektar::SolverUtils::FilterAverageFields::v_IsTimeDependent ( )
protectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 95 of file FilterAverageFields.cpp.

96 {
97  return true;
98 }
void Nektar::SolverUtils::FilterAverageFields::v_PrepareOutput ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const NekDouble time 
)
protectedvirtual
void Nektar::SolverUtils::FilterAverageFields::v_ProcessSample ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const NekDouble time 
)
protectedvirtual

Implements Nektar::SolverUtils::FilterSampler.

Definition at line 72 of file FilterAverageFields.cpp.

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

75 {
76  for(int n = 0; n < pFields.num_elements(); ++n)
77  {
78  Vmath::Vadd(m_outFields[n].num_elements(),
79  pFields[n]->GetCoeffs(),
80  1,
81  m_outFields[n],
82  1,
83  m_outFields[n],
84  1);
85  }
86 }
std::vector< Array< OneD, NekDouble > > m_outFields
Definition: FilterSampler.h:90
void Vadd(int n, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Add vector z = x+y.
Definition: Vmath.cpp:285

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:

Name of the class.

Definition at line 61 of file FilterAverageFields.h.