Nektar++
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// 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: Abstract base class for compressible solver artificial diffusion
32// used for shock capturing artificial diffusion.
33//
34///////////////////////////////////////////////////////////////////////////////
35
36#ifndef NEKTAR_SOLVERS_COMPRESSIBLEFLOWSOLVER_ARTIFICIALDIFFUSION_BASE
37#define NEKTAR_SOLVERS_COMPRESSIBLEFLOWSOLVER_ARTIFICIALDIFFUSION_BASE
38
39#include <string>
40
46
47namespace Nektar
48{
49// Forward declaration
50class ArtificialDiffusion;
51
52/// A shared pointer to a artificial diffusion object
53typedef std::shared_ptr<ArtificialDiffusion> ArtificialDiffusionSharedPtr;
54
55/// Declaration of the artificial diffusion factory
57 std::string, ArtificialDiffusion,
61
62/// Declaration of the artificial diffusion factory singleton
64
65/**
66 * @class ArtificialDiffusion
67 * @brief Encapsulates the artificial diffusion used in shock capture
68 */
70{
71public:
72 /// Apply the artificial diffusion
74 const Array<OneD, const Array<OneD, NekDouble>> &inarray,
76 {
77 v_DoArtificialDiffusion(inarray, outarray);
78 }
79
80 /// Apply the artificial diffusion the outarray is in coeff space
82 const Array<OneD, const Array<OneD, NekDouble>> &inarray,
84 {
85 v_DoArtificialDiffusionCoeff(inarray, outarray);
86 }
87
88 /// Calculate the artificial viscosity
90 const Array<OneD, Array<OneD, NekDouble>> &physfield,
92 {
93 v_GetArtificialViscosity(physfield, mu);
94 }
95
96protected:
97 /// Session reader
99 /// Array of fields
101 /// Auxiliary object to convert variables
103 /// LDG Diffusion operator
105 /// Constant scaling
107
108 /// Constructor
112 const int spacedim);
113
114 virtual ~ArtificialDiffusion() = default;
115
116 virtual void v_DoArtificialDiffusion(
117 const Array<OneD, const Array<OneD, NekDouble>> &inarray,
118 Array<OneD, Array<OneD, NekDouble>> &outarray);
119
120 virtual void v_DoArtificialDiffusionCoeff(
121 const Array<OneD, const Array<OneD, NekDouble>> &inarray,
122 Array<OneD, Array<OneD, NekDouble>> &outarray);
123
125 const Array<OneD, Array<OneD, NekDouble>> &physfield,
126 Array<OneD, NekDouble> &mu) = 0;
127
128 void GetFluxVector(
129 const Array<OneD, Array<OneD, NekDouble>> &inarray,
130 const Array<OneD, Array<OneD, Array<OneD, NekDouble>>> &qfield,
131 Array<OneD, Array<OneD, Array<OneD, NekDouble>>> &viscousTensor);
132};
133} // namespace Nektar
134
135#endif
Encapsulates the artificial diffusion used in shock capture.
void GetArtificialViscosity(const Array< OneD, Array< OneD, NekDouble > > &physfield, Array< OneD, NekDouble > &mu)
Calculate the artificial viscosity.
void DoArtificialDiffusionCoeff(const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
Apply the artificial diffusion the outarray is in coeff space.
virtual void v_GetArtificialViscosity(const Array< OneD, Array< OneD, NekDouble > > &physfield, Array< OneD, NekDouble > &mu)=0
Array< OneD, MultiRegions::ExpListSharedPtr > m_fields
Array of fields.
LibUtilities::SessionReaderSharedPtr m_session
Session reader.
virtual void v_DoArtificialDiffusion(const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
ArtificialDiffusion(const LibUtilities::SessionReaderSharedPtr &pSession, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const int spacedim)
Constructor.
NekDouble m_mu0
Constant scaling.
VariableConverterSharedPtr m_varConv
Auxiliary object to convert variables.
virtual void v_DoArtificialDiffusionCoeff(const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
void DoArtificialDiffusion(const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
Apply the artificial diffusion.
void GetFluxVector(const Array< OneD, Array< OneD, NekDouble > > &inarray, const Array< OneD, Array< OneD, Array< OneD, NekDouble > > > &qfield, Array< OneD, Array< OneD, Array< OneD, NekDouble > > > &viscousTensor)
Return the flux vector for the artificial viscosity operator.
virtual ~ArtificialDiffusion()=default
SolverUtils::DiffusionSharedPtr m_diffusion
LDG Diffusion operator.
Provides a generic Factory class.
std::shared_ptr< SessionReader > SessionReaderSharedPtr
std::shared_ptr< Diffusion > DiffusionSharedPtr
A shared pointer to an EquationSystem object.
Definition: Diffusion.h:55
std::shared_ptr< VariableConverter > VariableConverterSharedPtr
ArtificialDiffusionFactory & GetArtificialDiffusionFactory()
Declaration of the artificial diffusion factory singleton.
std::shared_ptr< ArtificialDiffusion > ArtificialDiffusionSharedPtr
A shared pointer to a artificial diffusion object.
double NekDouble
LibUtilities::NekFactory< std::string, ArtificialDiffusion, const LibUtilities::SessionReaderSharedPtr &, const Array< OneD, MultiRegions::ExpListSharedPtr > &, const int > ArtificialDiffusionFactory
Declaration of the artificial diffusion factory.