Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
ArtificialDiffusion.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: ArtificialDiffusion.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 // License for the specific language governing rights and limitations under
14 // Permission is hereby granted, free of charge, to any person obtaining a
15 // copy of this software and associated documentation files (the "Software"),
16 // to deal in the Software without restriction, including without limitation
17 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 // and/or sell copies of the Software, and to permit persons to whom the
19 // Software is furnished to do so, subject to the following conditions:
20 //
21 // The above copyright notice and this permission notice shall be included
22 // in all copies or substantial portions of the Software.
23 //
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 // DEALINGS IN THE SOFTWARE.
31 //
32 // Description: Abstract base class for compressible solver artificial diffusion
33 // used for shock capturing artificial diffusion.
34 //
35 ///////////////////////////////////////////////////////////////////////////////
36 
37 #ifndef NEKTAR_SOLVERS_COMPRESSIBLEFLOWSOLVER_ARTIFICIALDIFFUSION_BASE
38 #define NEKTAR_SOLVERS_COMPRESSIBLEFLOWSOLVER_ARTIFICIALDIFFUSION_BASE
39 
40 #include <string>
41 
45 #include <MultiRegions/ExpList.h>
47 
48 namespace Nektar
49 {
50 // Forward declaration
52 
53 /// A shared pointer to a artificial diffusion object
54 typedef boost::shared_ptr<ArtificialDiffusion> ArtificialDiffusionSharedPtr;
55 
56 /// Declaration of the artificial diffusion factory
61 
62 /// Declaration of the artificial diffusion factory singleton
63 ArtificialDiffusionFactory& GetArtificialDiffusionFactory();
64 
65 /**
66  * @class ArtificialDiffusion
67  * @brief Encapsulates the artificial diffusion used in shock capture
68  */
69 class ArtificialDiffusion
70 {
71  public:
72  virtual ~ArtificialDiffusion() {}
73 
74  /// Apply the artificial diffusion
76  const Array<OneD, const Array<OneD, NekDouble> > &inarray,
77  Array<OneD, Array<OneD, NekDouble> > &outarray);
78 
79  /// Calculate the artificial viscosity
81  const Array<OneD, Array<OneD, NekDouble> > &physfield,
83 
84  protected:
85  /// Session reader
86  LibUtilities::SessionReaderSharedPtr m_session;
87  /// Array of fields
88  Array<OneD, MultiRegions::ExpListSharedPtr> m_fields;
89  /// Auxiliary object to convert variables
91  /// LDG Diffusion operator
93 
94  /// Parameters
103 
104  /// Constructor
105  ArtificialDiffusion(const LibUtilities::SessionReaderSharedPtr& pSession,
106  const Array<OneD, MultiRegions::ExpListSharedPtr>& pFields,
107  const int spacedim);
108 
109  virtual void v_DoArtificialDiffusion(
110  const Array<OneD, const Array<OneD, NekDouble> > &inarray,
111  Array<OneD, Array<OneD, NekDouble> > &outarray);
112 
113  virtual void v_GetArtificialViscosity(
114  const Array<OneD, Array<OneD, NekDouble> > &physfield,
116 
117 };
118 }
119 
120 #endif
LibUtilities::NekFactory< std::string, ArtificialDiffusion, const LibUtilities::SessionReaderSharedPtr &, const Array< OneD, MultiRegions::ExpListSharedPtr > &, const int > ArtificialDiffusionFactory
Declaration of the artificial diffusion factory.
void DoArtificialDiffusion(const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
Apply the artificial diffusion.
boost::shared_ptr< ArtificialDiffusion > ArtificialDiffusionSharedPtr
A shared pointer to a artificial diffusion object.
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:51
Encapsulates the artificial diffusion used in shock capture.
SolverUtils::DiffusionSharedPtr m_diffusion
LDG Diffusion operator.
virtual void v_GetArtificialViscosity(const Array< OneD, Array< OneD, NekDouble > > &physfield, Array< OneD, NekDouble > &mu)=0
boost::shared_ptr< Diffusion > DiffusionSharedPtr
A shared pointer to an EquationSystem object.
Definition: Diffusion.h:162
ArtificialDiffusionFactory & GetArtificialDiffusionFactory()
Declaration of the artificial diffusion factory singleton.
double NekDouble
boost::shared_ptr< VariableConverter > VariableConverterSharedPtr
LibUtilities::SessionReaderSharedPtr m_session
Session reader.
ArtificialDiffusion(const LibUtilities::SessionReaderSharedPtr &pSession, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const int spacedim)
Constructor.
NekDouble m_FacL
Parameters.
virtual void v_DoArtificialDiffusion(const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
void GetArtificialViscosity(const Array< OneD, Array< OneD, NekDouble > > &physfield, Array< OneD, NekDouble > &mu)
Calculate the artificial viscosity.
VariableConverterSharedPtr m_varConv
Auxiliary object to convert variables.
Array< OneD, MultiRegions::ExpListSharedPtr > m_fields
Array of fields.
Provides a generic Factory class.
Definition: NekFactory.hpp:116