Nektar::SolverUtils::Advection3DHomogeneous1D Class Reference

#include <Advection3DHomogeneous1D.h>

Inheritance diagram for Nektar::SolverUtils::Advection3DHomogeneous1D:

Static Public Member Functions
static AdvectionSharedPtr	create (std::string advType)

Static Public Attributes
static std::string	type []

Protected Member Functions
	Advection3DHomogeneous1D (std::string advType)
void	v_InitObject (LibUtilities::SessionReaderSharedPtr pSession, Array< OneD, MultiRegions::ExpListSharedPtr > pFields) override
	Initiliase Advection3DHomogeneous1D objects and store them before starting the time-stepping.
void	v_Advect (const int nConvField, 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) override
	Compute the advection operator for a given input inarray and put the result in outarray.
Protected Member Functions inherited from Nektar::SolverUtils::Advection
virtual SOLVER_UTILS_EXPORT	~Advection ()=default
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.

Protected Attributes
std::string	m_advType
Protected Attributes inherited from Nektar::SolverUtils::Advection
AdvectionFluxVecCB	m_fluxVector
	Callback function to the flux vector (set when advection is in conservative form).
RiemannSolverSharedPtr	m_riemann
	Riemann solver for DG-type schemes.
int	m_spaceDim
	Storage for space dimension. Used for homogeneous extension.

Private Member Functions
void	ModifiedFluxVector (const Array< OneD, Array< OneD, NekDouble > > &physfield, Array< OneD, Array< OneD, Array< OneD, NekDouble > > > &flux)

Private Attributes
SolverUtils::AdvectionSharedPtr	m_planeAdv
int	m_numPoints
int	m_numPointsPlane
int	m_numPlanes
int	m_planeCounter
Array< OneD, unsigned int >	m_planes
Array< OneD, unsigned int >	m_planePos
Array< OneD, Array< OneD, Array< OneD, NekDouble > > >	m_fluxVecStore
Array< OneD, Array< OneD, NekDouble > >	m_inarrayPlane
Array< OneD, Array< OneD, NekDouble > >	m_outarrayPlane
Array< OneD, MultiRegions::ExpListSharedPtr >	m_fieldsPlane
Array< OneD, Array< OneD, NekDouble > >	m_advVelPlane
Array< OneD, Array< OneD, Array< OneD, Array< OneD, NekDouble > > > >	m_fluxVecPlane

Additional Inherited Members
Public Member Functions inherited from Nektar::SolverUtils::Advection
SOLVER_UTILS_EXPORT void	InitObject (LibUtilities::SessionReaderSharedPtr pSession, Array< OneD, MultiRegions::ExpListSharedPtr > pFields)
	Interface function to initialise the advection object.
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.
template<typename FuncPointerT , typename ObjectPointerT >
void	SetFluxVector (FuncPointerT func, ObjectPointerT obj)
	Set the flux vector callback function.
void	SetRiemannSolver (RiemannSolverSharedPtr riemann)
	Set a Riemann solver object for this advection object.
void	SetFluxVector (AdvectionFluxVecCB fluxVector)
	Set the flux vector callback function.
void	SetBaseFlow (const Array< OneD, Array< OneD, NekDouble > > &inarray, const Array< OneD, MultiRegions::ExpListSharedPtr > &fields)
	Set the base flow used for linearised advection objects.
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)

Detailed Description

Definition at line 45 of file Advection3DHomogeneous1D.h.

Constructor & Destructor Documentation

Advection3DHomogeneous1D()

Nektar::SolverUtils::Advection3DHomogeneous1D::Advection3DHomogeneous1D ( std::string  advType )

protected

Todo:

Extension to triangles, tetrahedra and other shapes. (Long term objective)

Definition at line 63 of file Advection3DHomogeneous1D.cpp.

    : m_advType(advType)
{
    // Strip trailing string "3DHomogeneous1D" to determine 2D advection
    // type, and create an advection object for the plane.
    std::string advName = advType.substr(0, advType.length() - 15);
    m_planeAdv = GetAdvectionFactory().CreateInstance(advName, advName);
}

References Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), Nektar::SolverUtils::GetAdvectionFactory(), and m_planeAdv.

Member Function Documentation

create()

static AdvectionSharedPtr Nektar::SolverUtils::Advection3DHomogeneous1D::create ( std::string  advType )

inlinestatic

Definition at line 48 of file Advection3DHomogeneous1D.h.

    {
        return AdvectionSharedPtr(new Advection3DHomogeneous1D(advType));
    }

ModifiedFluxVector()

void Nektar::SolverUtils::Advection3DHomogeneous1D::ModifiedFluxVector ( const Array< OneD, Array< OneD, NekDouble > > &  physfield, Array< OneD, Array< OneD, Array< OneD, NekDouble > > > &  flux  )

private

Definition at line 234 of file Advection3DHomogeneous1D.cpp.

{
    // Return section of flux vector for this plane.
    outarray = m_fluxVecPlane[m_planeCounter];
 
    // Increment the plane counter.
    m_planeCounter = (m_planeCounter + 1) % m_numPlanes;
}

References m_fluxVecPlane, m_numPlanes, and m_planeCounter.

Referenced by v_InitObject().

v_Advect()

void Nektar::SolverUtils::Advection3DHomogeneous1D::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  )

overrideprotectedvirtual

Compute the advection operator for a given input inarray and put the result in outarray.

Parameters

nConvectiveFields	Number of fields to advect.
fields	Pointer to fields.
advVel	Advection velocities.
inarray	Input which will be advected.
outarray	Computed advection.

Implements Nektar::SolverUtils::Advection.

Definition at line 178 of file Advection3DHomogeneous1D.cpp.

{
    Array<OneD, NekDouble> tmp(m_numPoints), tmp2;
    int nVel = advVel.size();
 
    // Call solver's flux vector function to compute the flux vector on
    // the entire domain.
    m_fluxVector(inarray, m_fluxVecStore);
 
    // Loop over each plane.
    for (int i = 0; i < m_numPlanes; ++i)
    {
        // Set up memory references for fields, inarray and outarray for
        // this plane.
        for (int j = 0; j < nConvectiveFields; ++j)
        {
            m_fieldsPlane[j]  = fields[j]->GetPlane(i);
            m_inarrayPlane[j] = Array<OneD, NekDouble>(
                m_numPointsPlane, tmp2 = inarray[j] + m_planePos[i]);
            m_outarrayPlane[j] = Array<OneD, NekDouble>(
                m_numPointsPlane, tmp2 = outarray[j] + m_planePos[i]);
        }
 
        for (int j = 0; j < nVel; ++j)
        {
            if (advVel[j].size() != 0)
            {
                m_advVelPlane[j] = Array<OneD, NekDouble>(
                    m_numPointsPlane, tmp2 = advVel[j] + m_planePos[i]);
            }
        }
 
        // Compute advection term for this plane.
        m_planeAdv->Advect(nConvectiveFields, m_fieldsPlane, m_advVelPlane,
                           m_inarrayPlane, m_outarrayPlane, time);
    }
 
    // Calculate Fourier derivative and add to final result.
    for (int i = 0; i < nConvectiveFields; ++i)
    {
        fields[0]->PhysDeriv(2, m_fluxVecStore[i][2], tmp);
 
        Vmath::Vadd(m_numPoints, outarray[i], 1, tmp, 1, outarray[i], 1);
    }
}

References m_advVelPlane, m_fieldsPlane, m_fluxVecStore, Nektar::SolverUtils::Advection::m_fluxVector, m_inarrayPlane, m_numPlanes, m_numPoints, m_numPointsPlane, m_outarrayPlane, m_planeAdv, m_planePos, and Vmath::Vadd().

v_InitObject()

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

overrideprotectedvirtual

Initiliase Advection3DHomogeneous1D objects and store them before starting the time-stepping.

Parameters

pSession	Pointer to session reader.
pFields	Pointer to fields.

Reimplemented from Nektar::SolverUtils::Advection.

Definition at line 79 of file Advection3DHomogeneous1D.cpp.

{
    int nConvectiveFields = pFields.size();
 
    Array<OneD, MultiRegions::ExpListSharedPtr> pFields_plane0(
        nConvectiveFields);
 
    // Initialise the plane advection object.
    for (int i = 0; i < nConvectiveFields; ++i)
    {
        pFields_plane0[i] = pFields[i]->GetPlane(0);
    }
    m_planeAdv->InitObject(pSession, pFields_plane0);
 
    m_numPoints      = pFields[0]->GetTotPoints();
    m_planes         = pFields[0]->GetZIDs();
    m_numPlanes      = m_planes.size();
    m_numPointsPlane = m_numPoints / m_numPlanes;
 
    // Set Riemann solver and flux vector callback for this plane.
    m_planeAdv->SetRiemannSolver(m_riemann);
    m_planeAdv->SetFluxVector(&Advection3DHomogeneous1D::ModifiedFluxVector,
                              this);
    m_planeCounter = 0;
 
    // Override Riemann solver scalar and vector callbacks.
    std::map<std::string, RSScalarFuncType> scalars = m_riemann->GetScalars();
    std::map<std::string, RSVecFuncType> vectors    = m_riemann->GetVectors();
 
    for (auto &it1 : scalars)
    {
        std::shared_ptr<HomoRSScalar> tmp =
            MemoryManager<HomoRSScalar>::AllocateSharedPtr(it1.second,
                                                           m_numPlanes);
        m_riemann->SetScalar(it1.first, &HomoRSScalar::Exec, tmp);
    }
 
    for (auto &it2 : vectors)
    {
        std::shared_ptr<HomoRSVector> tmp =
            MemoryManager<HomoRSVector>::AllocateSharedPtr(
                it2.second, m_numPlanes, it2.first);
        m_riemann->SetVector(it2.first, &HomoRSVector::Exec, tmp);
    }
 
    m_fluxVecStore =
        Array<OneD, Array<OneD, Array<OneD, NekDouble>>>(nConvectiveFields);
 
    // Set up storage for flux vector.
    for (int i = 0; i < nConvectiveFields; ++i)
    {
        m_fluxVecStore[i] = Array<OneD, Array<OneD, NekDouble>>(3);
        for (int j = 0; j < 3; ++j)
        {
            m_fluxVecStore[i][j] = Array<OneD, NekDouble>(m_numPoints);
        }
    }
 
    m_fluxVecPlane =
        Array<OneD, Array<OneD, Array<OneD, Array<OneD, NekDouble>>>>(
            m_numPlanes);
    m_fieldsPlane =
        Array<OneD, MultiRegions::ExpListSharedPtr>(nConvectiveFields);
    m_inarrayPlane  = Array<OneD, Array<OneD, NekDouble>>(nConvectiveFields);
    m_outarrayPlane = Array<OneD, Array<OneD, NekDouble>>(nConvectiveFields);
    m_planePos      = Array<OneD, unsigned int>(m_numPlanes);
    m_advVelPlane   = Array<OneD, Array<OneD, NekDouble>>(3);
 
    // Set up memory reference which links fluxVecPlane to fluxVecStore.
    for (int i = 0; i < m_numPlanes; ++i)
    {
        m_planePos[i] = i * m_numPointsPlane;
        m_fluxVecPlane[i] =
            Array<OneD, Array<OneD, Array<OneD, NekDouble>>>(nConvectiveFields);
 
        for (int j = 0; j < nConvectiveFields; ++j)
        {
            m_fluxVecPlane[i][j] = Array<OneD, Array<OneD, NekDouble>>(3);
            for (int k = 0; k < 3; ++k)
            {
                m_fluxVecPlane[i][j][k] = Array<OneD, NekDouble>(
                    m_numPointsPlane, m_fluxVecStore[j][k] + m_planePos[i]);
            }
        }
    }
}

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), Nektar::SolverUtils::HomoRSScalar::Exec(), Nektar::SolverUtils::HomoRSVector::Exec(), m_advVelPlane, m_fieldsPlane, m_fluxVecPlane, m_fluxVecStore, m_inarrayPlane, m_numPlanes, m_numPoints, m_numPointsPlane, m_outarrayPlane, m_planeAdv, m_planeCounter, m_planePos, m_planes, Nektar::SolverUtils::Advection::m_riemann, and ModifiedFluxVector().

Member Data Documentation

m_advType

std::string Nektar::SolverUtils::Advection3DHomogeneous1D::m_advType

protected

Definition at line 57 of file Advection3DHomogeneous1D.h.

m_advVelPlane

Array<OneD, Array<OneD, NekDouble> > Nektar::SolverUtils::Advection3DHomogeneous1D::m_advVelPlane

private

Definition at line 86 of file Advection3DHomogeneous1D.h.

Referenced by v_Advect(), and v_InitObject().

m_fieldsPlane

Array<OneD, MultiRegions::ExpListSharedPtr> Nektar::SolverUtils::Advection3DHomogeneous1D::m_fieldsPlane

private

Definition at line 85 of file Advection3DHomogeneous1D.h.

Referenced by v_Advect(), and v_InitObject().

m_fluxVecPlane

Array<OneD, Array<OneD, Array<OneD, Array<OneD, NekDouble> > > > Nektar::SolverUtils::Advection3DHomogeneous1D::m_fluxVecPlane

private

Definition at line 88 of file Advection3DHomogeneous1D.h.

Referenced by ModifiedFluxVector(), and v_InitObject().

m_fluxVecStore

Array<OneD, Array<OneD, Array<OneD, NekDouble> > > Nektar::SolverUtils::Advection3DHomogeneous1D::m_fluxVecStore

private

Definition at line 82 of file Advection3DHomogeneous1D.h.

Referenced by v_Advect(), and v_InitObject().

m_inarrayPlane

Array<OneD, Array<OneD, NekDouble> > Nektar::SolverUtils::Advection3DHomogeneous1D::m_inarrayPlane

private

Definition at line 83 of file Advection3DHomogeneous1D.h.

Referenced by v_Advect(), and v_InitObject().

m_numPlanes

int Nektar::SolverUtils::Advection3DHomogeneous1D::m_numPlanes

private

Definition at line 78 of file Advection3DHomogeneous1D.h.

Referenced by ModifiedFluxVector(), v_Advect(), and v_InitObject().

m_numPoints

int Nektar::SolverUtils::Advection3DHomogeneous1D::m_numPoints

private

Definition at line 76 of file Advection3DHomogeneous1D.h.

Referenced by v_Advect(), and v_InitObject().

m_numPointsPlane

int Nektar::SolverUtils::Advection3DHomogeneous1D::m_numPointsPlane

private

Definition at line 77 of file Advection3DHomogeneous1D.h.

Referenced by v_Advect(), and v_InitObject().

m_outarrayPlane

Array<OneD, Array<OneD, NekDouble> > Nektar::SolverUtils::Advection3DHomogeneous1D::m_outarrayPlane

private

Definition at line 84 of file Advection3DHomogeneous1D.h.

Referenced by v_Advect(), and v_InitObject().

m_planeAdv

SolverUtils::AdvectionSharedPtr Nektar::SolverUtils::Advection3DHomogeneous1D::m_planeAdv

private

Definition at line 75 of file Advection3DHomogeneous1D.h.

Referenced by Advection3DHomogeneous1D(), v_Advect(), and v_InitObject().

m_planeCounter

int Nektar::SolverUtils::Advection3DHomogeneous1D::m_planeCounter

private

Definition at line 79 of file Advection3DHomogeneous1D.h.

Referenced by ModifiedFluxVector(), and v_InitObject().

m_planePos

Array<OneD, unsigned int> Nektar::SolverUtils::Advection3DHomogeneous1D::m_planePos

private

Definition at line 81 of file Advection3DHomogeneous1D.h.

Referenced by v_Advect(), and v_InitObject().

m_planes

Array<OneD, unsigned int> Nektar::SolverUtils::Advection3DHomogeneous1D::m_planes

private

Definition at line 80 of file Advection3DHomogeneous1D.h.

Referenced by v_InitObject().

type

std::string Nektar::SolverUtils::Advection3DHomogeneous1D::type

static

Initial value:

= {
    GetAdvectionFactory().RegisterCreatorFunction(
        "WeakDG3DHomogeneous1D", Advection3DHomogeneous1D::create),
    GetAdvectionFactory().RegisterCreatorFunction(
        "FRDG3DHomogeneous1D", Advection3DHomogeneous1D::create),
    GetAdvectionFactory().RegisterCreatorFunction(
        "FRDG3DHomogeneous1D", Advection3DHomogeneous1D::create),
    GetAdvectionFactory().RegisterCreatorFunction(
        "FRSD3DHomogeneous1D", Advection3DHomogeneous1D::create),
    GetAdvectionFactory().RegisterCreatorFunction(
        "FRHU3DHomogeneous1D", Advection3DHomogeneous1D::create),
    GetAdvectionFactory().RegisterCreatorFunction(
        "FRcmin3DHomogeneous1D", Advection3DHomogeneous1D::create),
    GetAdvectionFactory().RegisterCreatorFunction(
        "FRcinf3DHomogeneous1D", Advection3DHomogeneous1D::create)}

Definition at line 52 of file Advection3DHomogeneous1D.h.