Nektar++
AdvectionFR.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: AdvectionFR.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: FR advection class.
32 //
33 ///////////////////////////////////////////////////////////////////////////////
34 
35 #ifndef NEKTAR_SOLVERUTILS_ADVECTIONFR
36 #define NEKTAR_SOLVERUTILS_ADVECTIONFR
37 
41 
42 namespace Nektar
43 {
44  namespace SolverUtils
45  {
46  class AdvectionFR : public Advection
47  {
48  public:
49  static AdvectionSharedPtr create(std::string advType)
50  {
51  return AdvectionSharedPtr(new AdvectionFR(advType));
52  }
53 
54  static std::string type[];
55 
58 
63 
72 
73  protected:
74  AdvectionFR(std::string advType);
75 
77 
78  std::string m_advType;
79 
80  virtual void v_InitObject(
83 
84  virtual void v_Advect(
85  const int nConvectiveFields,
87  const Array<OneD, Array<OneD, NekDouble> > &advVel,
88  const Array<OneD, Array<OneD, NekDouble> > &inarray,
89  Array<OneD, Array<OneD, NekDouble> > &outarray,
90  const NekDouble &time,
93 
94  virtual void v_SetupMetrics(
97 
98  virtual void v_SetupCFunctions(
101 
102  virtual void v_DivCFlux_1D(
103  const int nConvectiveFields,
105  const Array<OneD, const NekDouble> &fluxX1,
106  const Array<OneD, const NekDouble> &numericalFlux,
107  Array<OneD, NekDouble> &divCFlux);
108 
109  virtual void v_DivCFlux_2D(
110  const int nConvectiveFields,
112  const Array<OneD, const NekDouble> &fluxX1,
113  const Array<OneD, const NekDouble> &fluxX2,
114  const Array<OneD, const NekDouble> &numericalFlux,
115  Array<OneD, NekDouble> &divCFlux);
116 
117  virtual void v_DivCFlux_2D_Gauss(
118  const int nConvectiveFields,
120  const Array<OneD, const NekDouble> &fluxX1,
121  const Array<OneD, const NekDouble> &fluxX2,
122  const Array<OneD, const NekDouble> &numericalFlux,
123  Array<OneD, NekDouble> &divCFlux);
124 
125  virtual void v_DivCFlux_3D(
126  const int nConvectiveFields,
128  const Array<OneD, const NekDouble> &fluxX1,
129  const Array<OneD, const NekDouble> &fluxX2,
130  const Array<OneD, const NekDouble> &fluxX3,
131  const Array<OneD, const NekDouble> &numericalFlux,
132  Array<OneD, NekDouble> &divCFlux);
133  };
134  }
135 }
136 
137 #endif
Array< OneD, Array< OneD, NekDouble > > m_Q2D_e1
Definition: AdvectionFR.h:60
Array< OneD, Array< OneD, NekDouble > > m_dGL_xi1
Definition: AdvectionFR.h:64
Array< OneD, Array< OneD, NekDouble > > m_dGL_xi3
Definition: AdvectionFR.h:68
Array< OneD, Array< OneD, NekDouble > > m_dGR_xi1
Definition: AdvectionFR.h:65
Array< OneD, Array< OneD, NekDouble > > m_dGR_xi3
Definition: AdvectionFR.h:69
Array< OneD, Array< OneD, NekDouble > > m_Q2D_e0
Definition: AdvectionFR.h:59
Array< OneD, Array< OneD, NekDouble > > m_gmat
Definition: AdvectionFR.h:57
AdvectionFR(std::string advType)
AdvectionFR uses the Flux Reconstruction (FR) approach to compute the advection term. The implementation is only for segments, quadrilaterals and hexahedra at the moment.
Definition: AdvectionFR.cpp:78
std::shared_ptr< Advection > AdvectionSharedPtr
A shared pointer to an Advection object.
Definition: Advection.h:170
Array< OneD, Array< OneD, NekDouble > > m_dGR_xi2
Definition: AdvectionFR.h:67
Array< OneD, Array< OneD, NekDouble > > m_Q2D_e3
Definition: AdvectionFR.h:62
std::shared_ptr< DNekMat > DNekMatSharedPtr
Definition: NekTypeDefs.hpp:69
Array< OneD, Array< OneD, NekDouble > > m_Q2D_e2
Definition: AdvectionFR.h:61
double NekDouble
virtual void v_DivCFlux_3D(const int nConvectiveFields, const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, const NekDouble > &fluxX1, const Array< OneD, const NekDouble > &fluxX2, const Array< OneD, const NekDouble > &fluxX3, const Array< OneD, const NekDouble > &numericalFlux, Array< OneD, NekDouble > &divCFlux)
Compute the divergence of the corrective flux for 3D problems.
virtual void v_DivCFlux_2D_Gauss(const int nConvectiveFields, const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, const NekDouble > &fluxX1, const Array< OneD, const NekDouble > &fluxX2, const Array< OneD, const NekDouble > &numericalFlux, Array< OneD, NekDouble > &divCFlux)
Compute the divergence of the corrective flux for 2D problems where POINTSTYPE="GaussGaussLegendre".
virtual void v_DivCFlux_2D(const int nConvectiveFields, const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, const NekDouble > &fluxX1, const Array< OneD, const NekDouble > &fluxX2, const Array< OneD, const NekDouble > &numericalFlux, Array< OneD, NekDouble > &divCFlux)
Compute the divergence of the corrective flux for 2D problems.
Array< OneD, Array< OneD, NekDouble > > m_dGL_xi2
Definition: AdvectionFR.h:66
static AdvectionSharedPtr create(std::string advType)
Definition: AdvectionFR.h:49
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)
Compute the advection term at each time-step using the Flux Reconstruction approach (FR)...
virtual void v_SetupMetrics(LibUtilities::SessionReaderSharedPtr pSession, Array< OneD, MultiRegions::ExpListSharedPtr > pFields)
Setup the metric terms to compute the contravariant fluxes. (i.e. this special metric terms transform...
virtual void v_InitObject(LibUtilities::SessionReaderSharedPtr pSession, Array< OneD, MultiRegions::ExpListSharedPtr > pFields)
Initiliase AdvectionFR objects and store them before starting the time-stepping.
Definition: AdvectionFR.cpp:92
virtual void v_DivCFlux_1D(const int nConvectiveFields, const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, const NekDouble > &fluxX1, const Array< OneD, const NekDouble > &numericalFlux, Array< OneD, NekDouble > &divCFlux)
Compute the divergence of the corrective flux for 1D problems.
Array< OneD, Array< OneD, NekDouble > > m_traceNormals
Definition: AdvectionFR.h:76
static Array< OneD, Array< OneD, NekDouble > > NullNekDoubleArrayofArray
static std::string type[]
Definition: AdvectionFR.h:54
std::shared_ptr< SessionReader > SessionReaderSharedPtr
Array< OneD, NekDouble > m_jac
Definition: AdvectionFR.h:56
An abstract base class encapsulating the concept of advection of a vector field.
Definition: Advection.h:69
virtual void v_SetupCFunctions(LibUtilities::SessionReaderSharedPtr pSession, Array< OneD, MultiRegions::ExpListSharedPtr > pFields)
Setup the derivatives of the correction functions. For more details see J Sci Comput (2011) 47: 50–7...