laminar.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2007-2019, 2022 PCOpt/NTUA
9  Copyright (C) 2013-2019, 2022 FOSS GP
10  Copyright (C) 2019 OpenCFD Ltd.
11 -------------------------------------------------------------------------------
12 License
13  This file is part of OpenFOAM.
14 
15  OpenFOAM is free software: you can redistribute it and/or modify it
16  under the terms of the GNU General Public License as published by
17  the Free Software Foundation, either version 3 of the License, or
18  (at your option) any later version.
19 
20  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
21  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
22  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
23  for more details.
24 
25  You should have received a copy of the GNU General Public License
26  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
27 
28 
29 Class
30  Foam::incompressible::RASVariables::laminar
31 
32 Description
33 
34 SourceFiles
35  laminar.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef incompressible_RASVariables_laminar_H
40 #define incompressible_RASVariables_laminar_H
41 
42 #include "RASModelVariables.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 namespace incompressible
49 {
50 namespace RASVariables
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class laminar Declaration
55 \*---------------------------------------------------------------------------*/
56 
57 class laminar
58 :
59  public RASModelVariables
60 {
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("laminar");
66 
67 
68  // Constructors
69 
70  //- Construct from components
71  laminar
72  (
73  const fvMesh& mesh,
74  const solverControl& SolverControl
75  );
76 
77 
78  //- Destructor
79  virtual ~laminar() = default;
80 
81 
82  // Member Functions
83 
84  // Bools to identify which turbulent fields are present
85  inline virtual bool hasTMVar1() const
86  {
87  return false;
88  }
89  inline virtual bool hasTMVar2() const
90  {
91  return false;
92  }
93  inline virtual bool hasNut() const
94  {
95  return false;
96  }
97 };
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace RASVariables
103 } // End namespace incompressible
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
virtual bool hasTMVar1() const
Bools to identify which turbulent fields are present.
Definition: laminar.H:86
laminar(const fvMesh &mesh, const solverControl &SolverControl)
Construct from components.
Definition: laminar.C:43
virtual ~laminar()=default
Destructor.
dynamicFvMesh & mesh
Base class for solver control classes.
Definition: solverControl.H:45
TypeName("laminar")
Runtime type information.
Abstract base class for objective functions. No point in making this runTime selectable since its chi...
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Namespace for OpenFOAM.