Nektar::AdjointAdvection Class Reference

Advection for the adjoint form of the linearised Navier-Stokes equations. More...

#include <AdjointAdvection.h>

Inheritance diagram for Nektar::AdjointAdvection:

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

Static Public Attributes
static std::string	className
	Name of class. More...
Static Public Attributes inherited from Nektar::LinearisedAdvection
static std::string	className
	Name of class. More...

Protected Member Functions
	AdjointAdvection ()
	~AdjointAdvection () override
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) override
	Advects a vector field. More...
Protected Member Functions inherited from Nektar::LinearisedAdvection
DNekBlkMatSharedPtr	GetFloquetBlockMatrix (FloquetMatType mattype, bool UseContCoeffs=false) const
DNekBlkMatSharedPtr	GenFloquetBlockMatrix (FloquetMatType mattype, bool UseContCoeffs=false) const
	LinearisedAdvection ()
	~LinearisedAdvection () override
void	v_InitObject (LibUtilities::SessionReaderSharedPtr pSession, Array< OneD, MultiRegions::ExpListSharedPtr > pFields) override
	Initialises the advection object. More...
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) override
	Advects a vector field. More...
void	v_SetBaseFlow (const Array< OneD, Array< OneD, NekDouble > > &inarray, const Array< OneD, MultiRegions::ExpListSharedPtr > &fields) override
	Overrides the base flow used during linearised advection. More...
void	UpdateBase (const Array< OneD, const NekDouble > &inarray, Array< OneD, NekDouble > &outarray, const NekDouble time)
void	UpdateGradBase (const int var, const MultiRegions::ExpListSharedPtr &field)
void	DFT (const std::string file, Array< OneD, MultiRegions::ExpListSharedPtr > &pFields)
void	ImportFldBase (std::string pInfile, Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, int slice)
	Import Base flow. More...
virtual SOLVER_UTILS_EXPORT void	v_InitObject (LibUtilities::SessionReaderSharedPtr pSession, Array< OneD, MultiRegions::ExpListSharedPtr > pFields)
	Initialises the advection object. More...
virtual SOLVER_UTILS_EXPORT 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)=0
	Advects a vector field. More...
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< AdjointAdvection >

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...
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 inherited from Nektar::LinearisedAdvection
LibUtilities::SessionReaderSharedPtr	m_session
int	m_spacedim
int	m_expdim
Array< OneD, Array< OneD, NekDouble > >	m_baseflow
	Storage for base flow. More...
Array< OneD, Array< OneD, NekDouble > >	m_gradBase
int	m_start
	number of slices More...
int	m_skip
int	m_slices
NekDouble	m_period
	period length More...
int	m_isperiodic
int	m_interporder
Array< OneD, Array< OneD, NekDouble > >	m_interp
	interpolation vector More...
LibUtilities::NektarFFTSharedPtr	m_FFT
	auxiliary variables More...
Array< OneD, NekDouble >	m_tmpIN
Array< OneD, NekDouble >	m_tmpOUT
bool	m_useFFTW
bool	m_singleMode
	flag to determine if use single mode or not More...
bool	m_halfMode
	flag to determine if use half mode or not More...
bool	m_multipleModes
	flag to determine if use multiple mode or not More...
FloquetBlockMatrixMapShPtr	m_FloquetBlockMat
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

Advection for the adjoint form of the linearised Navier-Stokes equations.

Definition at line 44 of file AdjointAdvection.h.

Constructor & Destructor Documentation

AdjointAdvection()

Nektar::AdjointAdvection::AdjointAdvection ( )

protected

Definition at line 49 of file AdjointAdvection.cpp.

                                   : LinearisedAdvection()
{
}

~AdjointAdvection()

Nektar::AdjointAdvection::~AdjointAdvection ( )

overrideprotected

Definition at line 53 of file AdjointAdvection.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 50 of file AdjointAdvection.h.

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

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

v_Advect()

void Nektar::AdjointAdvection::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

Advects a vector field.

Implements Nektar::SolverUtils::Advection.

Definition at line 57 of file AdjointAdvection.cpp.

{
    ASSERTL1(nConvectiveFields == inarray.size(),
             "Number of convective fields and Inarray are not compatible");
 
    int nPointsTot  = fields[0]->GetNpoints();
    int ndim        = advVel.size();
    int nBaseDerivs = (m_halfMode || m_singleMode) ? 2 : m_spacedim;
    int nDerivs     = (m_halfMode) ? 2 : m_spacedim;
 
    Array<OneD, Array<OneD, NekDouble>> velocity(ndim);
    int nScalar = nConvectiveFields - ndim;
    Array<OneD, Array<OneD, NekDouble>> scalar(nScalar);
 
    for (int i = 0; i < ndim; ++i)
    {
        if (fields[i]->GetWaveSpace() && !m_singleMode && !m_halfMode)
        {
            velocity[i] = Array<OneD, NekDouble>(nPointsTot, 0.0);
            fields[i]->HomogeneousBwdTrans(nPointsTot, advVel[i], velocity[i]);
        }
        else
        {
            velocity[i] = advVel[i];
        }
    }
    if (nScalar > 0) // add for temperature field
    {
        for (int jj = ndim; jj < nConvectiveFields; ++jj)
        {
            scalar[jj - ndim] = inarray[jj];
        }
    }
 
    Array<OneD, Array<OneD, NekDouble>> grad(nDerivs);
    for (int i = 0; i < nDerivs; ++i)
    {
        grad[i] = Array<OneD, NekDouble>(nPointsTot);
    }
 
    // Evaluation of the base flow for periodic cases
    if (m_slices > 1)
    {
        for (int i = 0; i < ndim; ++i)
        {
            UpdateBase(m_interp[i], m_baseflow[i], m_period - time);
            UpdateGradBase(i, fields[i]);
        }
    }
 
    // Evaluate the linearised advection term
    for (int i = 0; i < nConvectiveFields; ++i)
    {
        // Calculate gradient
        switch (nDerivs)
        {
            case 1:
            {
                fields[i]->PhysDeriv(inarray[i], grad[0]);
            }
            break;
            case 2:
            {
                fields[i]->PhysDeriv(inarray[i], grad[0], grad[1]);
            }
            break;
            case 3:
            {
                fields[i]->PhysDeriv(inarray[i], grad[0], grad[1], grad[2]);
                if (m_multipleModes)
                {
                    // transform gradients into physical Fourier space
                    fields[i]->HomogeneousBwdTrans(nPointsTot, grad[0],
                                                   grad[0]);
                    fields[i]->HomogeneousBwdTrans(nPointsTot, grad[1],
                                                   grad[1]);
                    fields[i]->HomogeneousBwdTrans(nPointsTot, grad[2],
                                                   grad[2]);
                }
            }
            break;
        }
 
        // Momentum field advection
        if (i < ndim)
        {
            // Calculate -U_j du'_i/dx_j
            Vmath::Vmul(nPointsTot, grad[0], 1, m_baseflow[0], 1, outarray[i],
                        1);
            for (int j = 1; j < nDerivs; ++j)
            {
                Vmath::Vvtvp(nPointsTot, grad[j], 1, m_baseflow[j], 1,
                             outarray[i], 1, outarray[i], 1);
            }
            Vmath::Neg(nPointsTot, outarray[i], 1);
 
            // Add u'_j U_j/ dx_i
            int lim = (m_halfMode) ? 2 : ndim;
            if ((m_halfMode || m_singleMode) && i == 2)
            {
                lim = 0;
            }
            for (int j = 0; j < lim; ++j)
            {
                Vmath::Vvtvp(nPointsTot, m_gradBase[j * nBaseDerivs + i], 1,
                             velocity[j], 1, outarray[i], 1, outarray[i], 1);
            }
            // Add Tprime*Grad_Tbase in u, v equations
            if (nScalar > 0 && i < ndim)
            {
                for (int s = 0; s < nScalar; ++s)
                {
                    Vmath::Vvtvp(nPointsTot,
                                 m_gradBase[(ndim + s) * nBaseDerivs + i], 1,
                                 scalar[s], 1, outarray[i], 1, outarray[i], 1);
                }
            }
        }
        // Scalar Field Advection
        else
        {
            // Calculate -U_j du'_i/dx_j
            Vmath::Vmul(nPointsTot, grad[0], 1, m_baseflow[0], 1, outarray[i],
                        1);
            for (int j = 1; j < nDerivs; ++j)
            {
                Vmath::Vvtvp(nPointsTot, grad[j], 1, m_baseflow[j], 1,
                             outarray[i], 1, outarray[i], 1);
            }
            Vmath::Neg(nPointsTot, outarray[i], 1);
        }
 
        if (m_multipleModes)
        {
            fields[i]->HomogeneousFwdTrans(nPointsTot, outarray[i],
                                           outarray[i]);
        }
        Vmath::Neg(nPointsTot, outarray[i], 1);
    }
}

References ASSERTL1, Nektar::LinearisedAdvection::m_baseflow, Nektar::LinearisedAdvection::m_gradBase, Nektar::LinearisedAdvection::m_halfMode, Nektar::LinearisedAdvection::m_interp, Nektar::LinearisedAdvection::m_multipleModes, Nektar::LinearisedAdvection::m_period, Nektar::LinearisedAdvection::m_singleMode, Nektar::LinearisedAdvection::m_slices, Nektar::LinearisedAdvection::m_spacedim, Vmath::Neg(), Nektar::LinearisedAdvection::UpdateBase(), Nektar::LinearisedAdvection::UpdateGradBase(), Vmath::Vmul(), and Vmath::Vvtvp().

Friends And Related Function Documentation

MemoryManager< AdjointAdvection >

friend class MemoryManager< AdjointAdvection >

friend

Definition at line 1 of file AdjointAdvection.h.

Member Data Documentation

className

string Nektar::AdjointAdvection::className

static

Initial value:

=
    SolverUtils ::GetAdvectionFactory().RegisterCreatorFunction(
        "Adjoint", AdjointAdvection::create)

Name of class.

Definition at line 56 of file AdjointAdvection.h.