Nektar++
CFSBndCond.h
Go to the documentation of this file.
1///////////////////////////////////////////////////////////////////////////////
2//
3// File: CFSBndCond.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 boundary conditions.
32//
33///////////////////////////////////////////////////////////////////////////////
34
35#ifndef NEKTAR_SOLVERS_COMPRESSIBLEFLOWSOLVER_BNDCOND_CFSBNDCOND
36#define NEKTAR_SOLVERS_COMPRESSIBLEFLOWSOLVER_BNDCOND_CFSBNDCOND
37
38#include <string>
39
44
45namespace Nektar
46{
47
48// Forward declaration
49class CFSBndCond;
50
51/// A shared pointer to a boundary condition object
52typedef std::shared_ptr<CFSBndCond> CFSBndCondSharedPtr;
53
54/// Declaration of the boundary condition factory
59 const Array<OneD, Array<OneD, NekDouble>> &, const int, const int,
60 const int>
62
63/// Declaration of the boundary condition factory singleton
65
66/**
67 * @class CFSBndCond
68 * @brief Encapsulates the user-defined boundary conditions for compressible
69 * flow solver.
70 */
72{
73public:
74 /// Apply the boundary condition
77 const NekDouble &time = 0)
78 {
79 v_Apply(Fwd, physarray, time);
80 }
81
82 /// Apply the Weight of boundary condition
84 {
86 }
87
88protected:
89 /// Session reader
91 /// Array of fields
93 /// Trace normals
95 /// Grid Velocity
97 /// Space dimension
99 /// Auxiliary object to convert variables
101 /// Weight for average calculation of diffusion term
103
104 /// Parameters of the flow
111
112 /// Id of the boundary region
114 /// Offset
116
117 /// Constructor
120 const Array<OneD, Array<OneD, NekDouble>> &pTraceNormals,
121 const Array<OneD, Array<OneD, NekDouble>> &pGridVelocity,
122 const int pSpaceDim, const int bcRegion, const int cnt);
123
124 virtual ~CFSBndCond() = default;
125
127 Array<OneD, Array<OneD, NekDouble>> &physarray,
128 const NekDouble &time) = 0;
129
130 virtual void v_ApplyBwdWeight();
131};
132} // namespace Nektar
133
134#endif
Encapsulates the user-defined boundary conditions for compressible flow solver.
Definition: CFSBndCond.h:72
NekDouble m_rhoInf
Definition: CFSBndCond.h:106
virtual void v_Apply(Array< OneD, Array< OneD, NekDouble > > &Fwd, Array< OneD, Array< OneD, NekDouble > > &physarray, const NekDouble &time)=0
NekDouble m_diffusionAveWeight
Weight for average calculation of diffusion term.
Definition: CFSBndCond.h:102
void Apply(Array< OneD, Array< OneD, NekDouble > > &Fwd, Array< OneD, Array< OneD, NekDouble > > &physarray, const NekDouble &time=0)
Apply the boundary condition.
Definition: CFSBndCond.h:75
LibUtilities::SessionReaderSharedPtr m_session
Session reader.
Definition: CFSBndCond.h:90
NekDouble m_pInf
Definition: CFSBndCond.h:107
int m_spacedim
Space dimension.
Definition: CFSBndCond.h:98
virtual ~CFSBndCond()=default
Array< OneD, Array< OneD, NekDouble > > m_gridVelocityTrace
Grid Velocity.
Definition: CFSBndCond.h:96
Array< OneD, Array< OneD, NekDouble > > m_traceNormals
Trace normals.
Definition: CFSBndCond.h:94
Array< OneD, NekDouble > m_velInf
Definition: CFSBndCond.h:109
void ApplyBwdWeight()
Apply the Weight of boundary condition.
Definition: CFSBndCond.h:83
NekDouble m_gamma
Parameters of the flow.
Definition: CFSBndCond.h:105
int m_bcRegion
Id of the boundary region.
Definition: CFSBndCond.h:113
VariableConverterSharedPtr m_varConv
Auxiliary object to convert variables.
Definition: CFSBndCond.h:100
CFSBndCond(const LibUtilities::SessionReaderSharedPtr &pSession, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const Array< OneD, Array< OneD, NekDouble > > &pTraceNormals, const Array< OneD, Array< OneD, NekDouble > > &pGridVelocity, const int pSpaceDim, const int bcRegion, const int cnt)
Constructor.
Definition: CFSBndCond.cpp:46
int m_offset
Offset.
Definition: CFSBndCond.h:115
Array< OneD, MultiRegions::ExpListSharedPtr > m_fields
Array of fields.
Definition: CFSBndCond.h:92
NekDouble m_angVel
Definition: CFSBndCond.h:110
NekDouble m_pOut
Definition: CFSBndCond.h:108
virtual void v_ApplyBwdWeight()
Definition: CFSBndCond.cpp:88
Provides a generic Factory class.
std::shared_ptr< SessionReader > SessionReaderSharedPtr
CFSBndCondFactory & GetCFSBndCondFactory()
Declaration of the boundary condition factory singleton.
Definition: CFSBndCond.cpp:40
std::shared_ptr< VariableConverter > VariableConverterSharedPtr
std::shared_ptr< CFSBndCond > CFSBndCondSharedPtr
A shared pointer to a boundary condition object.
Definition: CFSBndCond.h:52
LibUtilities::NekFactory< std::string, CFSBndCond, const LibUtilities::SessionReaderSharedPtr &, const Array< OneD, MultiRegions::ExpListSharedPtr > &, const Array< OneD, Array< OneD, NekDouble > > &, const Array< OneD, Array< OneD, NekDouble > > &, const int, const int, const int > CFSBndCondFactory
Declaration of the boundary condition factory.
Definition: CFSBndCond.h:61
double NekDouble