All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
viscosity.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2021 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::viscosity
26 
27 Description
28  Abstract base class for all fluid physical properties
29 
30 SourceFiles
31  viscosity.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef viscosity_H
36 #define viscosity_H
37 
38 #include "primitiveFieldsFwd.H"
39 #include "volFieldsFwd.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class viscosity Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class viscosity
51 {
52 public:
53 
54  //- Runtime type information
55  TypeName("viscosity");
56 
57 
58  // Constructors
59 
60  //- Construct
61  viscosity()
62  {}
63 
64  //- Disallow default bitwise copy construction
65  viscosity(const viscosity&) = delete;
66 
67 
68  //- Destructor
69  virtual ~viscosity()
70  {}
71 
72 
73  // Member Functions
74 
75  //- Return the laminar viscosity
76  virtual tmp<volScalarField> nu() const = 0;
77 
78  //- Return the laminar viscosity for patch
79  virtual tmp<scalarField> nu(const label patchi) const = 0;
80 
81 
82  // Member Operators
83 
84  //- Disallow default bitwise assignment
85  void operator=(const viscosity&) = delete;
86 };
87 
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************************************************************* //
A class for managing temporary objects.
Definition: tmp.H:55
Abstract base class for all fluid physical properties.
Definition: viscosity.H:50
virtual ~viscosity()
Destructor.
Definition: viscosity.H:68
viscosity()
Construct.
Definition: viscosity.H:60
TypeName("viscosity")
Runtime type information.
virtual tmp< volScalarField > nu() const =0
Return the laminar viscosity.
void operator=(const viscosity &)=delete
Disallow default bitwise assignment.
label patchi
Namespace for OpenFOAM.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.