Newtonian.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 | Copyright (C) 2011-2016 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::viscosityModels::Newtonian
26 
27 Description
28  An incompressible Newtonian viscosity model.
29 
30 SourceFiles
31  Newtonian.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef Newtonian_H
36 #define Newtonian_H
37 
38 #include "viscosityModel.H"
39 #include "dimensionedScalar.H"
40 #include "volFields.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace viscosityModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class Newtonian Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class Newtonian
54 :
55  public viscosityModel
56 {
57  // Private data
58 
59  dimensionedScalar nu0_;
60 
61  volScalarField nu_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("Newtonian");
68 
69 
70  // Constructors
71 
72  //- Construct from components
73  Newtonian
74  (
75  const word& name,
77  const volVectorField& U,
78  const surfaceScalarField& phi
79  );
80 
81 
82  //- Destructor
83  virtual ~Newtonian()
84  {}
85 
86 
87  // Member Functions
88 
89  //- Return the laminar viscosity
90  virtual tmp<volScalarField> nu() const
91  {
92  return nu_;
93  }
94 
95  //- Return the laminar viscosity for patch
96  virtual tmp<scalarField> nu(const label patchi) const
97  {
98  return nu_.boundaryField()[patchi];
99  }
100 
101  //- Correct the laminar viscosity (not appropriate, viscosity constant)
102  virtual void correct()
103  {}
104 
105  //- Read transportProperties dictionary
106  virtual bool read(const dictionary& viscosityProperties);
107 };
108 
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 } // End namespace viscosityModels
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #endif
118 
119 // ************************************************************************* //
surfaceScalarField & phi
An incompressible Newtonian viscosity model.
Definition: Newtonian.H:52
U
Definition: pEqn.H:83
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
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const Boundary & boundaryField() const
Return const-reference to the boundary field.
virtual tmp< volScalarField > nu() const
Return the laminar viscosity.
Definition: Newtonian.H:89
An abstract base class for incompressible viscosityModels.
virtual ~Newtonian()
Destructor.
Definition: Newtonian.H:82
const dictionary & viscosityProperties() const
Return the phase transport properties dictionary.
A class for handling words, derived from string.
Definition: word.H:59
Newtonian(const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
Construct from components.
Definition: Newtonian.C:45
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
virtual bool read(const dictionary &viscosityProperties)
Read transportProperties dictionary.
Definition: Newtonian.C:73
label patchi
virtual void correct()
Correct the laminar viscosity (not appropriate, viscosity constant)
Definition: Newtonian.H:101
TypeName("Newtonian")
Runtime type information.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.