Nektar++
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
Nektar::AdjointAdvection Class Reference

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

#include <AdjointAdvection.h>

Inheritance diagram for Nektar::AdjointAdvection:
[legend]

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 ()
 
virtual ~AdjointAdvection ()
 
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) 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 ()
 
virtual ~LinearisedAdvection ()
 
virtual void v_InitObject (LibUtilities::SessionReaderSharedPtr pSession, Array< OneD, MultiRegions::ExpListSharedPtr > pFields) override
 Initialises the advection object. More...
 
virtual 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...
 
- Protected Member Functions inherited from Nektar::SolverUtils::Advection
virtual SOLVER_UTILS_EXPORT void v_AdvectVolumeFlux (const int nConvectiveFields, const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble >> &advVel, const Array< OneD, Array< OneD, NekDouble >> &inarray, TensorOfArray3D< NekDouble > &pVolumeFlux, const NekDouble &time)
 Advects Volume Flux. More...
 
virtual SOLVER_UTILS_EXPORT void v_AdvectTraceFlux (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 >> &pTraceFlux, const NekDouble &time, const Array< OneD, Array< OneD, NekDouble >> &pFwd=NullNekDoubleArrayOfArray, const Array< OneD, Array< OneD, NekDouble >> &pBwd=NullNekDoubleArrayOfArray)
 Advects Trace Flux. More...
 
virtual SOLVER_UTILS_EXPORT void v_AdvectCoeffs (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)
 
virtual SOLVER_UTILS_EXPORT void v_AddVolumJacToMat (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const int &nConvectiveFields, const TensorOfArray5D< NekDouble > &ElmtJacArray, Array< OneD, Array< OneD, SNekBlkMatSharedPtr >> &gmtxarray)
 

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...
 
SOLVER_UTILS_EXPORT void AdvectVolumeFlux (const int nConvectiveFields, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const Array< OneD, Array< OneD, NekDouble >> &pAdvVel, const Array< OneD, Array< OneD, NekDouble >> &pInarray, TensorOfArray3D< NekDouble > &pVolumeFlux, const NekDouble &pTime)
 Interface function to advect the Volume field. More...
 
SOLVER_UTILS_EXPORT void AdvectTraceFlux (const int nConvectiveFields, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const Array< OneD, Array< OneD, NekDouble >> &pAdvVel, const Array< OneD, Array< OneD, NekDouble >> &pInarray, Array< OneD, Array< OneD, NekDouble >> &pTraceFlux, const NekDouble &pTime, const Array< OneD, Array< OneD, NekDouble >> &pFwd=NullNekDoubleArrayOfArray, const Array< OneD, Array< OneD, NekDouble >> &pBwd=NullNekDoubleArrayOfArray)
 Interface function to advect the Trace field. More...
 
SOLVER_UTILS_EXPORT void AdvectCoeffs (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)
 Similar with Advection::Advect(): calculate the advection flux The difference is in the outarray: it is the coefficients of basis for AdvectCoeffs() it is the physics on quadrature points for Advect() 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)
 
SOLVER_UTILS_EXPORT void AddVolumJacToMat (const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const int &nConvectiveFields, const TensorOfArray5D< NekDouble > &ElmtJacArray, Array< OneD, Array< OneD, SNekBlkMatSharedPtr >> &gmtxarray)
 
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.

49  : LinearisedAdvection()
50 {
51 }

◆ ~AdjointAdvection()

Nektar::AdjointAdvection::~AdjointAdvection ( )
protectedvirtual

Definition at line 53 of file AdjointAdvection.cpp.

54 {
55 }

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.

51  {
52  return MemoryManager<AdjointAdvection>::AllocateSharedPtr();
53  }
Nektar::MemoryManager::AllocateSharedPtr
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.
Definition: NekMemoryManager.hpp:168

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.

Reimplemented from Nektar::LinearisedAdvection.

Definition at line 57 of file AdjointAdvection.cpp.

65 {
66  boost::ignore_unused(pFwd, pBwd);
67  ASSERTL1(nConvectiveFields == inarray.size(),
68  "Number of convective fields and Inarray are not compatible");
69 
70  int nPointsTot = fields[0]->GetNpoints();
71  int ndim = advVel.size();
72  int nBaseDerivs = (m_halfMode || m_singleMode) ? 2 : m_spacedim;
73  int nDerivs = (m_halfMode) ? 2 : m_spacedim;
74 
75  Array<OneD, Array<OneD, NekDouble>> velocity(ndim);
76  int nScalar = nConvectiveFields - ndim;
77  Array<OneD, Array<OneD, NekDouble>> scalar(nScalar);
78 
79  for (int i = 0; i < ndim; ++i)
80  {
81  if (fields[i]->GetWaveSpace() && !m_singleMode && !m_halfMode)
82  {
83  velocity[i] = Array<OneD, NekDouble>(nPointsTot, 0.0);
84  fields[i]->HomogeneousBwdTrans(nPointsTot, advVel[i], velocity[i]);
85  }
86  else
87  {
88  velocity[i] = advVel[i];
89  }
90  }
91  if (nScalar > 0) // add for temperature field
92  {
93  for (int jj = ndim; jj < nConvectiveFields; ++jj)
94  {
95  scalar[jj - ndim] = inarray[jj];
96  }
97  }
98 
99  Array<OneD, Array<OneD, NekDouble>> grad(nDerivs);
100  for (int i = 0; i < nDerivs; ++i)
101  {
102  grad[i] = Array<OneD, NekDouble>(nPointsTot);
103  }
104 
105  // Evaluation of the base flow for periodic cases
106  if (m_slices > 1)
107  {
108  for (int i = 0; i < ndim; ++i)
109  {
110  UpdateBase(m_interp[i], m_baseflow[i], m_period - time);
111  UpdateGradBase(i, fields[i]);
112  }
113  }
114 
115  // Evaluate the linearised advection term
116  for (int i = 0; i < nConvectiveFields; ++i)
117  {
118  // Calculate gradient
119  switch (nDerivs)
120  {
121  case 1:
122  {
123  fields[i]->PhysDeriv(inarray[i], grad[0]);
124  }
125  break;
126  case 2:
127  {
128  fields[i]->PhysDeriv(inarray[i], grad[0], grad[1]);
129  }
130  break;
131  case 3:
132  {
133  fields[i]->PhysDeriv(inarray[i], grad[0], grad[1], grad[2]);
134  if (m_multipleModes)
135  {
136  // transform gradients into physical Fourier space
137  fields[i]->HomogeneousBwdTrans(nPointsTot, grad[0],
138  grad[0]);
139  fields[i]->HomogeneousBwdTrans(nPointsTot, grad[1],
140  grad[1]);
141  fields[i]->HomogeneousBwdTrans(nPointsTot, grad[2],
142  grad[2]);
143  }
144  }
145  break;
146  }
147 
148  // Momentum field advection
149  if (i < ndim)
150  {
151  // Calculate -U_j du'_i/dx_j
152  Vmath::Vmul(nPointsTot, grad[0], 1, m_baseflow[0], 1, outarray[i],
153  1);
154  for (int j = 1; j < nDerivs; ++j)
155  {
156  Vmath::Vvtvp(nPointsTot, grad[j], 1, m_baseflow[j], 1,
157  outarray[i], 1, outarray[i], 1);
158  }
159  Vmath::Neg(nPointsTot, outarray[i], 1);
160 
161  // Add u'_j U_j/ dx_i
162  int lim = (m_halfMode) ? 2 : ndim;
163  if ((m_halfMode || m_singleMode) && i == 2)
164  {
165  lim = 0;
166  }
167  for (int j = 0; j < lim; ++j)
168  {
169  Vmath::Vvtvp(nPointsTot, m_gradBase[j * nBaseDerivs + i], 1,
170  velocity[j], 1, outarray[i], 1, outarray[i], 1);
171  }
172  // Add Tprime*Grad_Tbase in u, v equations
173  if (nScalar > 0 && i < ndim)
174  {
175  for (int s = 0; s < nScalar; ++s)
176  {
177  Vmath::Vvtvp(nPointsTot,
178  m_gradBase[(ndim + s) * nBaseDerivs + i], 1,
179  scalar[s], 1, outarray[i], 1, outarray[i], 1);
180  }
181  }
182  }
183  // Scalar Field Advection
184  else
185  {
186  // Calculate -U_j du'_i/dx_j
187  Vmath::Vmul(nPointsTot, grad[0], 1, m_baseflow[0], 1, outarray[i],
188  1);
189  for (int j = 1; j < nDerivs; ++j)
190  {
191  Vmath::Vvtvp(nPointsTot, grad[j], 1, m_baseflow[j], 1,
192  outarray[i], 1, outarray[i], 1);
193  }
194  Vmath::Neg(nPointsTot, outarray[i], 1);
195  }
196 
197  if (m_multipleModes)
198  {
199  fields[i]->HomogeneousFwdTrans(nPointsTot, outarray[i],
200  outarray[i]);
201  }
202  Vmath::Neg(nPointsTot, outarray[i], 1);
203  }
204 }
ASSERTL1
#define ASSERTL1(condition, msg)
Assert Level 1 – Debugging which is used whether in FULLDEBUG or DEBUG compilation mode....
Definition: ErrorUtil.hpp:249
Nektar::LinearisedAdvection::UpdateBase
void UpdateBase(const Array< OneD, const NekDouble > &inarray, Array< OneD, NekDouble > &outarray, const NekDouble time)
Definition: LinearisedAdvection.cpp:506
Nektar::LinearisedAdvection::m_period
NekDouble m_period
period length
Definition: LinearisedAdvection.h:84
Nektar::LinearisedAdvection::UpdateGradBase
void UpdateGradBase(const int var, const MultiRegions::ExpListSharedPtr &field)
Definition: LinearisedAdvection.cpp:577
Nektar::LinearisedAdvection::m_singleMode
bool m_singleMode
flag to determine if use single mode or not
Definition: LinearisedAdvection.h:95
Nektar::LinearisedAdvection::m_baseflow
Array< OneD, Array< OneD, NekDouble > > m_baseflow
Storage for base flow.
Definition: LinearisedAdvection.h:76
Nektar::LinearisedAdvection::m_gradBase
Array< OneD, Array< OneD, NekDouble > > m_gradBase
Definition: LinearisedAdvection.h:77
Nektar::LinearisedAdvection::m_multipleModes
bool m_multipleModes
flag to determine if use multiple mode or not
Definition: LinearisedAdvection.h:99
Nektar::LinearisedAdvection::m_halfMode
bool m_halfMode
flag to determine if use half mode or not
Definition: LinearisedAdvection.h:97
Nektar::LinearisedAdvection::m_interp
Array< OneD, Array< OneD, NekDouble > > m_interp
interpolation vector
Definition: LinearisedAdvection.h:88
Vmath::Vmul
void Vmul(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:209
Vmath::Neg
void Neg(int n, T *x, const int incx)
Negate x = -x.
Definition: Vmath.cpp:518
Vmath::Vvtvp
void Vvtvp(int n, const T *w, const int incw, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
vvtvp (vector times vector plus vector): z = w*x + y
Definition: Vmath.cpp:574

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)
Nektar::AdjointAdvection::create
static SolverUtils::AdvectionSharedPtr create(std::string)
Creates an instance of this class.
Definition: AdjointAdvection.h:50
Nektar::LibUtilities::NekFactory::RegisterCreatorFunction
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, std::string pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:198
Nektar::SolverUtils::GetAdvectionFactory
AdvectionFactory & GetAdvectionFactory()
Gets the factory for initialising advection objects.
Definition: Advection.cpp:47

Name of class.

Definition at line 56 of file AdjointAdvection.h.

Generated on Sat Mar 25 2023 12:35:56 for Nektar++ by doxygen 1.9.1