Nektar++
ForcingCFSSyntheticEddy.h
Go to the documentation of this file.
1//////////////////////////////////////////////////////////////////////////////
2//
3// File: ForcingCFSSyntheticEddy.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: Derived base class - Synthetic turbulence forcing for the
32// Compressible solver.
33//
34///////////////////////////////////////////////////////////////////////////////
35
36#ifndef NEKTAR_SOLVERUTILS_FORCINGCFSSYNTHETICEDDY
37#define NEKTAR_SOLVERUTILS_FORCINGCFSSYNTHETICEDDY
38
42#include <string>
43
44namespace Nektar::SolverUtils
45{
46
49{
50public:
52
53 /// Creates an instance of this class
56 const std::weak_ptr<EquationSystem> &pEquation,
58 const unsigned int &pNumForcingFields, const TiXmlElement *pForce)
59 {
62 pSession, pEquation);
63 p->InitObject(pFields, pNumForcingFields, pForce);
64 return p;
65 }
66
67 /// Name of the class
68 static std::string className;
69
70protected:
71 // Apply forcing term
73 const Array<OneD, Array<OneD, NekDouble>> &inarray,
75 const NekDouble &time) override;
76 // Apply forcing term
77 void v_ApplyCoeff(
79 const Array<OneD, Array<OneD, NekDouble>> &inarray,
81 const NekDouble &time) override;
82 /// Calculate Forcing
85 /// Compute Velocity Fluctuation
88 const Array<OneD, Array<OneD, NekDouble>> &velFLuc,
89 std::pair<NekDouble, NekDouble> rhoMachMean);
90 /// Compute rho and mach mean
91 std::pair<NekDouble, NekDouble> ComputeRhoMachMean(
93
94 /// Auxiliary object to convert variables
96
97private:
100 const std::weak_ptr<EquationSystem> &pEquation);
101 ~ForcingCFSSyntheticEddy(void) override = default;
102};
103
104} // namespace Nektar::SolverUtils
105
106#endif
General purpose memory allocation routines with the ability to allocate from thread specific memory p...
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.
~ForcingCFSSyntheticEddy(void) override=default
void v_ApplyCoeff(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time) override
Apply forcing term if an eddy left the box of eddies and update the eddies positions.
void CalculateForcing(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields)
Calculate Forcing.
std::pair< NekDouble, NekDouble > ComputeRhoMachMean(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields)
Compute rho and mach mean.
VariableConverterSharedPtr m_varConv
Auxiliary object to convert variables.
void v_Apply(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time) override
Apply forcing term if an eddy left the box of eddies and update the eddies positions.
ForcingCFSSyntheticEddy(const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation)
Array< OneD, Array< OneD, NekDouble > > ComputeDensityFluctuation(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const Array< OneD, Array< OneD, NekDouble > > &velFLuc, std::pair< NekDouble, NekDouble > rhoMachMean)
Compute Velocity Fluctuation.
static ForcingSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)
Creates an instance of this class.
static std::string className
Name of the class.
Defines a forcing term to be explicitly applied.
Definition: Forcing.h:71
std::shared_ptr< SessionReader > SessionReaderSharedPtr
SOLVER_UTILS_EXPORT typedef std::shared_ptr< Forcing > ForcingSharedPtr
A shared pointer to an EquationSystem object.
Definition: Forcing.h:53
std::shared_ptr< VariableConverter > VariableConverterSharedPtr
double NekDouble