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,
70  const NekDouble &time,
75 
76  virtual void v_AdvectCoeffs(
77  const int nConvective,
79  const Array<OneD, Array<OneD, NekDouble> > &advVel,
80  const Array<OneD, Array<OneD, NekDouble> > &inarray,
81  Array<OneD, Array<OneD, NekDouble> > &outarray,
82  const NekDouble &time,
87 
88  virtual void v_AdvectVolumeFlux(
89  const int nConvectiveFields,
91  const Array<OneD, Array<OneD, NekDouble>> &advVel,
92  const Array<OneD, Array<OneD, NekDouble>> &inarray,
93  TensorOfArray3D<NekDouble> &VolumeFlux,
94  const NekDouble &time)
95  {
96  boost::ignore_unused(nConvectiveFields, fields, advVel, inarray,
97  VolumeFlux, time);
98  m_fluxVector(inarray, VolumeFlux);
99  }
100 
101  virtual void v_AdvectTraceFlux(
102  const int nConvective,
104  const Array<OneD, Array<OneD, NekDouble>> &advVel,
105  const Array<OneD, Array<OneD, NekDouble>> &inarray,
106  Array<OneD, Array<OneD, NekDouble>> &TraceFlux,
107  const NekDouble &time,
112 
113  virtual void v_AddVolumJacToMat(
115  const int &nConvectiveFields,
116  const TensorOfArray5D<NekDouble> &ElmtJacArray,
118 
119  };
120  }
121 }
122 
123 #endif
An abstract base class encapsulating the concept of advection of a vector field.
Definition: Advection.h:73
AdvectionFluxVecCB m_fluxVector
Callback function to the flux vector (set when advection is in conservative form).
Definition: Advection.h:221
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)
Compute the advection term at each time-step using the Discontinuous Galerkin approach (DG).
virtual void v_InitObject(LibUtilities::SessionReaderSharedPtr pSession, Array< OneD, MultiRegions::ExpListSharedPtr > pFields)
Initialise AdvectionWeakDG objects and store them before starting the time-stepping.
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)
virtual void v_AddVolumJacToMat(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const int &nConvectiveFields, const TensorOfArray5D< NekDouble > &ElmtJacArray, Array< OneD, Array< OneD, SNekBlkMatSharedPtr >> &gmtxarray)
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)
static AdvectionSharedPtr create(std::string advType)
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)
std::shared_ptr< SessionReader > SessionReaderSharedPtr
std::shared_ptr< Advection > AdvectionSharedPtr
A shared pointer to an Advection object.
Definition: Advection.h:291
The above copyright notice and this permission notice shall be included.
Definition: CoupledSolver.h:1
static Array< OneD, Array< OneD, NekDouble > > NullNekDoubleArrayOfArray
double NekDouble