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

#include <FilterEnergy.h>

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

Public Member Functions

SOLVER_UTILS_EXPORT FilterEnergy (const LibUtilities::SessionReaderSharedPtr &pSession, const std::map< std::string, std::string > &pParams)
 
SOLVER_UTILS_EXPORT ~FilterEnergy ()
 
SOLVER_UTILS_EXPORT FilterEnergy (const LibUtilities::SessionReaderSharedPtr &pSession, const std::map< std::string, std::string > &pParams)
 
SOLVER_UTILS_EXPORT ~FilterEnergy ()
 
- Public Member Functions inherited from Nektar::SolverUtils::FilterEnergyBase
SOLVER_UTILS_EXPORT FilterEnergyBase (const LibUtilities::SessionReaderSharedPtr &pSession, const std::map< std::string, std::string > &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 FilterSharedPtr create (const LibUtilities::SessionReaderSharedPtr &pSession, const std::map< std::string, std::string > &pParams)
 Creates an instance of this class. More...
 
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_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

- Protected Attributes inherited from Nektar::SolverUtils::Filter
LibUtilities::SessionReaderSharedPtr m_session
 

Detailed Description

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

Constructor & Destructor Documentation

Nektar::SolverUtils::FilterEnergy::FilterEnergy ( const LibUtilities::SessionReaderSharedPtr pSession,
const std::map< std::string, std::string > &  pParams 
)

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

48  : FilterEnergyBase(pSession, pParams, false)
49  {
50 
51  }
SOLVER_UTILS_EXPORT FilterEnergyBase(const LibUtilities::SessionReaderSharedPtr &pSession, const std::map< std::string, std::string > &pParams, const bool pConstDensity=true)
Nektar::SolverUtils::FilterEnergy::~FilterEnergy ( )

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

54  {
55 
56  }
SOLVER_UTILS_EXPORT Nektar::SolverUtils::FilterEnergy::FilterEnergy ( const LibUtilities::SessionReaderSharedPtr pSession,
const std::map< std::string, std::string > &  pParams 
)
SOLVER_UTILS_EXPORT Nektar::SolverUtils::FilterEnergy::~FilterEnergy ( )

Member Function Documentation

static FilterSharedPtr Nektar::SolverUtils::FilterEnergy::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 CompressibleFlowSolver/Filters/FilterEnergy.h.

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

53  {
55  ::AllocateSharedPtr(pSession, pParams);
56  return p;
57  }
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 FilterSharedPtr Nektar::SolverUtils::FilterEnergy::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 IncNavierStokesSolver/Filters/FilterEnergy.h.

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

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

Reimplemented from Nektar::SolverUtils::FilterEnergyBase.

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

69  {
70  return pFields[0]->GetPhys();
71  }
void Nektar::SolverUtils::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 58 of file CompressibleFlowSolver/Filters/FilterEnergy.cpp.

References Vmath::Vdiv().

62  {
63  Vmath::Vdiv(pFields[0]->GetNpoints(), pFields[i+1]->GetPhys(), 1,
64  pFields[0]->GetPhys(), 1, velocity, 1);
65  }
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::SolverUtils::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::SolverUtils::FilterEnergy::className
static
Initial value:
RegisterCreatorFunction("Energy", FilterEnergy::create)

Name of the class.

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