Nektar++
|
An abstract base class encapsulating the concept of advection of a vector field. More...
#include <Advection.h>
Public Member Functions | |
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... | |
template<typename DataType , typename TypeNekBlkMatSharedPtr > | |
SOLVER_UTILS_EXPORT void | AddTraceJacToMat (const int nConvectiveFields, const int nSpaceDim, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const Array< OneD, TypeNekBlkMatSharedPtr > &TracePntJacCons, Array< OneD, Array< OneD, TypeNekBlkMatSharedPtr > > &gmtxarray, const Array< OneD, TypeNekBlkMatSharedPtr > &TracePntJacGrad, const Array< OneD, Array< OneD, DataType > > &TracePntJacGradSign) |
template<typename DataType , typename TypeNekBlkMatSharedPtr > | |
void | CalcJacobTraceInteg (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const int m, const int n, const Array< OneD, const TypeNekBlkMatSharedPtr > &PntJac, const Array< OneD, const Array< OneD, DataType > > &PntJacSign, Array< OneD, DNekMatSharedPtr > &TraceJacFwd, Array< OneD, DNekMatSharedPtr > &TraceJacBwd) |
template<typename DataType , typename TypeNekBlkMatSharedPtr > | |
void | AddTraceJacToMat (const int nConvectiveFields, const int nSpaceDim, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const Array< OneD, TypeNekBlkMatSharedPtr > &TracePntJacCons, Array< OneD, Array< OneD, TypeNekBlkMatSharedPtr > > &gmtxarray, const Array< OneD, TypeNekBlkMatSharedPtr > &TracePntJacGrad, const Array< OneD, Array< OneD, DataType > > &TracePntJacGradSign) |
Protected Attributes | |
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... | |
An abstract base class encapsulating the concept of advection of a vector field.
Subclasses override the Advection::v_InitObject function to initialise the object and the Advection::v_Advect function to evaluate the advection of the vector field.
Definition at line 80 of file Advection.h.
|
protectedvirtualdefault |
void Nektar::SolverUtils::Advection::AddTraceJacToMat | ( | const int | nConvectiveFields, |
const int | nSpaceDim, | ||
const Array< OneD, MultiRegions::ExpListSharedPtr > & | pFields, | ||
const Array< OneD, TypeNekBlkMatSharedPtr > & | TracePntJacCons, | ||
Array< OneD, Array< OneD, TypeNekBlkMatSharedPtr > > & | gmtxarray, | ||
const Array< OneD, TypeNekBlkMatSharedPtr > & | TracePntJacGrad, | ||
const Array< OneD, Array< OneD, DataType > > & | TracePntJacGradSign | ||
) |
Definition at line 50 of file Advection.cpp.
References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), CalcJacobTraceInteg(), Nektar::Array< OneD, const DataType >::size(), Vmath::Vadd(), and Vmath::Vcopy().
SOLVER_UTILS_EXPORT void Nektar::SolverUtils::Advection::AddTraceJacToMat | ( | const int | nConvectiveFields, |
const int | nSpaceDim, | ||
const Array< OneD, MultiRegions::ExpListSharedPtr > & | pFields, | ||
const Array< OneD, TypeNekBlkMatSharedPtr > & | TracePntJacCons, | ||
Array< OneD, Array< OneD, TypeNekBlkMatSharedPtr > > & | gmtxarray, | ||
const Array< OneD, TypeNekBlkMatSharedPtr > & | TracePntJacGrad, | ||
const Array< OneD, Array< OneD, DataType > > & | TracePntJacGradSign | ||
) |
|
inline |
Interface function to advect the vector field.
Definition at line 92 of file Advection.h.
References v_Advect().
void Nektar::SolverUtils::Advection::CalcJacobTraceInteg | ( | const Array< OneD, MultiRegions::ExpListSharedPtr > & | pFields, |
const int | m, | ||
const int | n, | ||
const Array< OneD, const TypeNekBlkMatSharedPtr > & | PntJac, | ||
const Array< OneD, const Array< OneD, DataType > > & | PntJacSign, | ||
Array< OneD, DNekMatSharedPtr > & | TraceJacFwd, | ||
Array< OneD, DNekMatSharedPtr > & | TraceJacBwd | ||
) |
Definition at line 210 of file Advection.cpp.
Referenced by AddTraceJacToMat().
|
inline |
Interface function to initialise the advection object.
Definition at line 84 of file Advection.h.
References v_InitObject().
|
inline |
Set the base flow used for linearised advection objects.
inarray | Vector to use as baseflow |
Definition at line 146 of file Advection.h.
References v_SetBaseFlow().
|
inline |
Set the flux vector callback function.
fluxVector | The callback function to override. |
Definition at line 136 of file Advection.h.
References m_fluxVector.
|
inline |
Set the flux vector callback function.
This routine is a utility function to avoid the explicit use of std::bind. A function and object can be passed to this function instead.
Definition at line 115 of file Advection.h.
References m_fluxVector.
|
inline |
Set a Riemann solver object for this advection object.
riemann | The RiemannSolver object. |
Definition at line 126 of file Advection.h.
References m_riemann.
|
protectedpure virtual |
Advects a vector field.
Implemented in Nektar::SolverUtils::AdvectionNonConservative, Nektar::SolverUtils::AdvectionWeakDG, Nektar::SolverUtils::AdvectionFR, Nektar::AdjointAdvection, Nektar::AlternateSkewAdvection, Nektar::LinearisedAdvection, Nektar::NavierStokesAdvection, Nektar::NoAdvection, Nektar::SkewSymmetricAdvection, and Nektar::SolverUtils::Advection3DHomogeneous1D.
Referenced by Advect().
|
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.
pSession | Session information. |
pFields | Expansion lists for scalar fields. |
Reimplemented in Nektar::SolverUtils::Advection3DHomogeneous1D, Nektar::SolverUtils::AdvectionFR, Nektar::SolverUtils::AdvectionNonConservative, Nektar::SolverUtils::AdvectionWeakDG, Nektar::AlternateSkewAdvection, Nektar::LinearisedAdvection, Nektar::NavierStokesAdvection, Nektar::NoAdvection, and Nektar::SkewSymmetricAdvection.
Definition at line 264 of file Advection.cpp.
References Nektar::ErrorUtil::efatal, m_spaceDim, and NEKERROR.
Referenced by InitObject(), Nektar::SolverUtils::AdvectionFR::v_InitObject(), Nektar::SolverUtils::AdvectionNonConservative::v_InitObject(), Nektar::SolverUtils::AdvectionWeakDG::v_InitObject(), Nektar::LinearisedAdvection::v_InitObject(), Nektar::NavierStokesAdvection::v_InitObject(), and Nektar::SkewSymmetricAdvection::v_InitObject().
|
protectedvirtual |
Overrides the base flow used during linearised advection.
Reimplemented in Nektar::LinearisedAdvection.
Definition at line 291 of file Advection.cpp.
References Nektar::ErrorUtil::efatal, and NEKERROR.
Referenced by SetBaseFlow().
|
protected |
Callback function to the flux vector (set when advection is in conservative form).
Definition at line 175 of file Advection.h.
Referenced by Nektar::SolverUtils::AdvectionWeakDG::AdvectVolumeFlux(), SetFluxVector(), Nektar::SolverUtils::AdvectionFR::v_Advect(), and Nektar::SolverUtils::Advection3DHomogeneous1D::v_Advect().
|
protected |
Riemann solver for DG-type schemes.
Definition at line 177 of file Advection.h.
Referenced by Nektar::SolverUtils::AdvectionWeakDG::AdvectTraceFlux(), SetRiemannSolver(), Nektar::SolverUtils::AdvectionFR::v_Advect(), and Nektar::SolverUtils::Advection3DHomogeneous1D::v_InitObject().
|
protected |
Storage for space dimension. Used for homogeneous extension.
Definition at line 179 of file Advection.h.
Referenced by Nektar::SolverUtils::AdvectionWeakDG::AdvectCoeffs(), Nektar::SolverUtils::AdvectionWeakDG::AdvectTraceFlux(), Nektar::SolverUtils::AdvectionFR::v_Advect(), and v_InitObject().