Nektar::NoAdvection Class Reference

#include <NoAdvection.h>

Inheritance diagram for Nektar::NoAdvection:

Static Public Member Functions
static SolverUtils::AdvectionSharedPtr	create (std::string)
	Creates an instance of this class. More...

Static Public Attributes
static std::string	className
	Name of class. More...

Protected Member Functions
	NoAdvection ()
virtual	~NoAdvection ()
virtual void	v_InitObject (LibUtilities::SessionReaderSharedPtr pSession, Array< OneD, MultiRegions::ExpListSharedPtr > pFields)
	Initialises the advection object. More...
virtual void	v_Advect (const int nConvectiveFields, const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &advVel, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time, const Array< OneD, Array< OneD, NekDouble > > &pFwd=NullNekDoubleArrayofArray, const Array< OneD, Array< OneD, NekDouble > > &pBwd=NullNekDoubleArrayofArray)
	Advects a vector field. More...
Protected Member Functions inherited from Nektar::SolverUtils::Advection
virtual SOLVER_UTILS_EXPORT void	v_SetBaseFlow (const Array< OneD, Array< OneD, NekDouble > > &inarray, const Array< OneD, MultiRegions::ExpListSharedPtr > &fields)
	Overrides the base flow used during linearised advection. More...

Friends
class	MemoryManager< NoAdvection >

Additional Inherited Members
Public Member Functions inherited from Nektar::SolverUtils::Advection
virtual SOLVER_UTILS_EXPORT	~Advection ()
SOLVER_UTILS_EXPORT void	InitObject (LibUtilities::SessionReaderSharedPtr pSession, Array< OneD, MultiRegions::ExpListSharedPtr > pFields)
	Interface function to initialise the advection object. More...
SOLVER_UTILS_EXPORT void	Advect (const int nConvectiveFields, const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &advVel, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time, const Array< OneD, Array< OneD, NekDouble > > &pFwd=NullNekDoubleArrayofArray, const Array< OneD, Array< OneD, NekDouble > > &pBwd=NullNekDoubleArrayofArray)
	Interface function to advect the vector field. More...
template<typename FuncPointerT , typename ObjectPointerT >
void	SetFluxVector (FuncPointerT func, ObjectPointerT obj)
	Set the flux vector callback function. More...
void	SetRiemannSolver (RiemannSolverSharedPtr riemann)
	Set a Riemann solver object for this advection object. More...
void	SetFluxVector (AdvectionFluxVecCB fluxVector)
	Set the flux vector callback function. More...
void	SetBaseFlow (const Array< OneD, Array< OneD, NekDouble > > &inarray, const Array< OneD, MultiRegions::ExpListSharedPtr > &fields)
	Set the base flow used for linearised advection objects. More...
Protected Attributes inherited from Nektar::SolverUtils::Advection
AdvectionFluxVecCB	m_fluxVector
	Callback function to the flux vector (set when advection is in conservative form). More...
RiemannSolverSharedPtr	m_riemann
	Riemann solver for DG-type schemes. More...
int	m_spaceDim
	Storage for space dimension. Used for homogeneous extension. More...

Detailed Description

Definition at line 43 of file NoAdvection.h.

Constructor & Destructor Documentation

NoAdvection()

Nektar::NoAdvection::NoAdvection ( )

protected

Definition at line 50 of file NoAdvection.cpp.

                        :
        Advection()

{
}

~NoAdvection()

Nektar::NoAdvection::~NoAdvection ( )

protectedvirtual

Definition at line 60 of file NoAdvection.cpp.

{
}

Member Function Documentation

create()

static SolverUtils::AdvectionSharedPtr Nektar::NoAdvection::create ( std::string  )

inlinestatic

Creates an instance of this class.

Definition at line 49 of file NoAdvection.h.

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

                                                           {
        return MemoryManager<NoAdvection>::AllocateSharedPtr();
    }

v_Advect()

void Nektar::NoAdvection::v_Advect ( const int  nConvectiveFields, const Array< OneD, MultiRegions::ExpListSharedPtr > &  fields, const Array< OneD, Array< OneD, NekDouble > > &  advVel, const Array< OneD, Array< OneD, NekDouble > > &  inarray, Array< OneD, Array< OneD, NekDouble > > &  outarray, const NekDouble &  time, const Array< OneD, Array< OneD, NekDouble > > &  pFwd = NullNekDoubleArrayofArray, const Array< OneD, Array< OneD, NekDouble > > &  pBwd = NullNekDoubleArrayofArray  )

protectedvirtual

Advects a vector field.

Implements Nektar::SolverUtils::Advection.

Definition at line 78 of file NoAdvection.cpp.

References Vmath::Zero().

{
    int nPointsTot = fields[0]->GetNpoints();
    for (int i = 0; i < inarray.num_elements(); ++i)
    {
        Vmath::Zero(nPointsTot,outarray[i],1);
    }
}

v_InitObject()

void Nektar::NoAdvection::v_InitObject ( LibUtilities::SessionReaderSharedPtr  pSession, Array< OneD, MultiRegions::ExpListSharedPtr >  pFields  )

protectedvirtual

Initialises the advection object.

This function should be overridden in derived classes to initialise the specific advection data members. However, this base class function should be called as the first statement of the overridden function to ensure the base class is correctly initialised in order.

Parameters

pSession	Session information.
pFields	Expansion lists for scalar fields.

Reimplemented from Nektar::SolverUtils::Advection.

Definition at line 68 of file NoAdvection.cpp.

{
}

Friends And Related Function Documentation

MemoryManager< NoAdvection >

friend class MemoryManager< NoAdvection >

friend

Definition at line 46 of file NoAdvection.h.

Member Data Documentation

className

string Nektar::NoAdvection::className

static

Initial value:

= SolverUtils::GetAdvectionFactory().RegisterCreatorFunction(
            "NoAdvection",
            NoAdvection::create)

Name of class.

Definition at line 54 of file NoAdvection.h.