Nektar++
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
Nektar::FilterEnergy Class Reference

#include <FilterEnergy.h>

Inheritance diagram for Nektar::FilterEnergy:
Inheritance graph
[legend]
Collaboration diagram for Nektar::FilterEnergy:
Collaboration graph
[legend]

Public Member Functions

SOLVER_UTILS_EXPORT FilterEnergy (const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
 
SOLVER_UTILS_EXPORT ~FilterEnergy ()
 
SOLVER_UTILS_EXPORT FilterEnergy (const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
 
SOLVER_UTILS_EXPORT ~FilterEnergy ()
 
- Public Member Functions inherited from Nektar::SolverUtils::FilterEnergyBase
SOLVER_UTILS_EXPORT FilterEnergyBase (const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams, const bool pConstDensity=true)
 
SOLVER_UTILS_EXPORT ~FilterEnergyBase ()
 
- 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 SolverUtils::FilterSharedPtr create (const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
 Creates an instance of this class. More...
 
static SolverUtils::FilterSharedPtr create (const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &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_GetVelocity (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const int i, Array< OneD, NekDouble > &velocity)
 
virtual Array< OneD, NekDoublev_GetDensity (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields)
 
virtual void v_GetVelocity (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const int i, Array< OneD, NekDouble > &velocity)
 
- Protected Member Functions inherited from Nektar::SolverUtils::FilterEnergyBase
virtual SOLVER_UTILS_EXPORT void v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pField, const NekDouble &time)
 
virtual SOLVER_UTILS_EXPORT void v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pField, const NekDouble &time)
 
virtual SOLVER_UTILS_EXPORT void v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pField, const NekDouble &time)
 
virtual SOLVER_UTILS_EXPORT bool v_IsTimeDependent ()
 

Friends

class MemoryManager< FilterEnergy >
 

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 44 of file CompressibleFlowSolver/Filters/FilterEnergy.h.

Constructor & Destructor Documentation

Nektar::FilterEnergy::FilterEnergy ( const LibUtilities::SessionReaderSharedPtr pSession,
const ParamMap pParams 
)

Definition at line 44 of file CompressibleFlowSolver/Filters/FilterEnergy.cpp.

47  : FilterEnergyBase(pSession, pParams, false)
48 {
49 
50 }
SOLVER_UTILS_EXPORT FilterEnergyBase(const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams, const bool pConstDensity=true)
Nektar::FilterEnergy::~FilterEnergy ( )

Definition at line 52 of file CompressibleFlowSolver/Filters/FilterEnergy.cpp.

53 {
54 
55 }
SOLVER_UTILS_EXPORT Nektar::FilterEnergy::FilterEnergy ( const LibUtilities::SessionReaderSharedPtr pSession,
const ParamMap pParams 
)
SOLVER_UTILS_EXPORT Nektar::FilterEnergy::~FilterEnergy ( )

Member Function Documentation

static SolverUtils::FilterSharedPtr Nektar::FilterEnergy::create ( const LibUtilities::SessionReaderSharedPtr pSession,
const ParamMap pParams 
)
inlinestatic

Creates an instance of this class.

Definition at line 50 of file CompressibleFlowSolver/Filters/FilterEnergy.h.

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

52  {
54  ::AllocateSharedPtr(pSession, pParams);
55  return p;
56  }
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
static SolverUtils::FilterSharedPtr Nektar::FilterEnergy::create ( const LibUtilities::SessionReaderSharedPtr pSession,
const ParamMap pParams 
)
inlinestatic

Creates an instance of this class.

Definition at line 50 of file IncNavierStokesSolver/Filters/FilterEnergy.h.

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

52  {
54  ::AllocateSharedPtr(pSession, pParams);
55  return p;
56  }
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
Array< OneD, NekDouble > Nektar::FilterEnergy::v_GetDensity ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields)
protectedvirtual

Reimplemented from Nektar::SolverUtils::FilterEnergyBase.

Definition at line 66 of file CompressibleFlowSolver/Filters/FilterEnergy.cpp.

68 {
69  return pFields[0]->GetPhys();
70 }
void Nektar::FilterEnergy::v_GetVelocity ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const int  i,
Array< OneD, NekDouble > &  velocity 
)
protectedvirtual

Reimplemented from Nektar::SolverUtils::FilterEnergyBase.

Definition at line 57 of file CompressibleFlowSolver/Filters/FilterEnergy.cpp.

References Vmath::Vdiv().

61 {
62  Vmath::Vdiv(pFields[0]->GetNpoints(), pFields[i+1]->GetPhys(), 1,
63  pFields[0]->GetPhys(), 1, velocity, 1);
64 }
void Vdiv(int n, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Multiply vector z = x/y.
Definition: Vmath.cpp:227
virtual void Nektar::FilterEnergy::v_GetVelocity ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const int  i,
Array< OneD, NekDouble > &  velocity 
)
protectedvirtual

Friends And Related Function Documentation

friend class MemoryManager< FilterEnergy >
friend

Member Data Documentation

static std::string Nektar::FilterEnergy::className
static
Initial value:
RegisterCreatorFunction("Energy", FilterEnergy::create)

Name of the class.

Definition at line 59 of file CompressibleFlowSolver/Filters/FilterEnergy.h.