Nektar++
AdvectionWeakDG.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: AdvectionWeakDG.h
4 //
5 // For more information, please see: http://www.nektar.info
6 //
7 // The MIT License
8 //
9 // Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10 // Department of Aeronautics, Imperial College London (UK), and Scientific
11 // Computing and Imaging Institute, University of Utah (USA).
12 //
13 // Permission is hereby granted, free of charge, to any person obtaining a
14 // copy of this software and associated documentation files (the "Software"),
15 // to deal in the Software without restriction, including without limitation
16 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
17 // and/or sell copies of the Software, and to permit persons to whom the
18 // Software is furnished to do so, subject to the following conditions:
19 //
20 // The above copyright notice and this permission notice shall be included
21 // in all copies or substantial portions of the Software.
22 //
23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29 // DEALINGS IN THE SOFTWARE.
30 //
31 // Description: Weak DG advection class.
32 //
33 ///////////////////////////////////////////////////////////////////////////////
34 
35 #ifndef NEKTAR_SOLVERUTILS_ADVECTIONWEAKDG
36 #define NEKTAR_SOLVERUTILS_ADVECTIONWEAKDG
37 
38 #include <boost/core/ignore_unused.hpp>
39 
41 
42 namespace Nektar
43 {
44 namespace SolverUtils
45 {
46 class AdvectionWeakDG : public Advection
47 {
48 public:
49  static AdvectionSharedPtr create(std::string advType)
50  {
51  boost::ignore_unused(advType);
52  return AdvectionSharedPtr(new AdvectionWeakDG());
53  }
54 
55  static std::string type;
56 
57 protected:
59 
60  virtual void v_InitObject(
63 
64  virtual void v_Advect(
65  const int nConvective,
67  const Array<OneD, Array<OneD, NekDouble>> &advVel,
68  const Array<OneD, Array<OneD, NekDouble>> &inarray,
69  Array<OneD, Array<OneD, NekDouble>> &outarray, const NekDouble &time,
70  const Array<OneD, Array<OneD, NekDouble>> &pFwd =
72  const Array<OneD, Array<OneD, NekDouble>> &pBwd =
73  NullNekDoubleArrayOfArray) override;
74 
75  virtual void v_AdvectCoeffs(
76  const int nConvective,
78  const Array<OneD, Array<OneD, NekDouble>> &advVel,
79  const Array<OneD, Array<OneD, NekDouble>> &inarray,
80  Array<OneD, Array<OneD, NekDouble>> &outarray, const NekDouble &time,
81  const Array<OneD, Array<OneD, NekDouble>> &pFwd =
83  const Array<OneD, Array<OneD, NekDouble>> &pBwd =
84  NullNekDoubleArrayOfArray) override;
85 
86  virtual void v_AdvectVolumeFlux(
87  const int nConvectiveFields,
89  const Array<OneD, Array<OneD, NekDouble>> &advVel,
90  const Array<OneD, Array<OneD, NekDouble>> &inarray,
91  TensorOfArray3D<NekDouble> &VolumeFlux, const NekDouble &time) override
92  {
93  boost::ignore_unused(nConvectiveFields, fields, advVel, inarray,
94  VolumeFlux, time);
95  m_fluxVector(inarray, VolumeFlux);
96  }
97 
98  virtual void v_AdvectTraceFlux(
99  const int nConvective,
101  const Array<OneD, Array<OneD, NekDouble>> &advVel,
102  const Array<OneD, Array<OneD, NekDouble>> &inarray,
103  Array<OneD, Array<OneD, NekDouble>> &TraceFlux, const NekDouble &time,
104  const Array<OneD, Array<OneD, NekDouble>> &pFwd =
106  const Array<OneD, Array<OneD, NekDouble>> &pBwd =
107  NullNekDoubleArrayOfArray) override;
108 
109  virtual void v_AddVolumJacToMat(
111  const int &nConvectiveFields,
112  const TensorOfArray5D<NekDouble> &ElmtJacArray,
113  Array<OneD, Array<OneD, SNekBlkMatSharedPtr>> &gmtxarray) override;
114 };
115 } // namespace SolverUtils
116 } // namespace Nektar
117 
118 #endif
An abstract base class encapsulating the concept of advection of a vector field.
Definition: Advection.h:70
AdvectionFluxVecCB m_fluxVector
Callback function to the flux vector (set when advection is in conservative form).
Definition: Advection.h:211
virtual void v_InitObject(LibUtilities::SessionReaderSharedPtr pSession, Array< OneD, MultiRegions::ExpListSharedPtr > pFields) override
Initialise AdvectionWeakDG objects and store them before starting the time-stepping.
virtual void v_AddVolumJacToMat(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const int &nConvectiveFields, const TensorOfArray5D< NekDouble > &ElmtJacArray, Array< OneD, Array< OneD, SNekBlkMatSharedPtr >> &gmtxarray) override
virtual void v_AdvectTraceFlux(const int nConvective, 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 >> &TraceFlux, const NekDouble &time, const Array< OneD, Array< OneD, NekDouble >> &pFwd=NullNekDoubleArrayOfArray, const Array< OneD, Array< OneD, NekDouble >> &pBwd=NullNekDoubleArrayOfArray) override
Advects Trace Flux.
virtual 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 > &VolumeFlux, const NekDouble &time) override
Advects Volume Flux.
static AdvectionSharedPtr create(std::string advType)
virtual void v_Advect(const int nConvective, 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 term at each time-step using the Discontinuous Galerkin approach (DG).
virtual void v_AdvectCoeffs(const int nConvective, 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
std::shared_ptr< SessionReader > SessionReaderSharedPtr
std::shared_ptr< Advection > AdvectionSharedPtr
A shared pointer to an Advection object.
Definition: Advection.h:278
The above copyright notice and this permission notice shall be included.
Definition: CoupledSolver.h:2
static Array< OneD, Array< OneD, NekDouble > > NullNekDoubleArrayOfArray
double NekDouble