singlePhaseTransportModel.C
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) 2011-2018 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 \*---------------------------------------------------------------------------*/
25 
27 #include "viscosityModel.H"
28 #include "volFields.H"
29 
30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
31 
32 namespace Foam
33 {
34  defineTypeNameAndDebug(singlePhaseTransportModel, 0);
35 }
36 
37 
38 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
39 
41 (
42  const volVectorField& U,
43  const surfaceScalarField& phi
44 )
45 :
47  (
48  IOobject
49  (
50  "transportProperties",
51  U.time().constant(),
52  U.db(),
55  )
56  ),
57  viscosityModelPtr_(viscosityModel::New("nu", *this, U, phi))
58 {}
59 
60 
61 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
62 
64 {}
65 
66 
67 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
68 
71 {
72  return viscosityModelPtr_->nu();
73 }
74 
75 
78 {
79  return viscosityModelPtr_->nu(patchi);
80 }
81 
82 
84 {
85  viscosityModelPtr_->correct();
86 }
87 
88 
90 {
91  if (regIOobject::read())
92  {
93  return viscosityModelPtr_->read(*this);
94  }
95  else
96  {
97  return false;
98  }
99 }
100 
101 
102 // ************************************************************************* //
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
virtual bool read()
Read object.
virtual bool read()
Read transportProperties dictionary.
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:52
const word & constant() const
Return constant name.
Definition: TimePaths.H:124
virtual void correct()
Correct the laminar viscosity.
defineTypeNameAndDebug(combustionModel, 0)
singlePhaseTransportModel(const volVectorField &U, const surfaceScalarField &phi)
Construct from components.
label patchi
const Time & time() const
Return time.
Definition: IOobject.C:360
static autoPtr< viscosityModel > New(const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
Return a reference to the selected viscosity model.
virtual ~singlePhaseTransportModel()
Destructor.
A class for managing temporary objects.
Definition: PtrList.H:53
const objectRegistry & db() const
Return the local objectRegistry.
Definition: IOobject.C:354
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:92
Namespace for OpenFOAM.
virtual tmp< volScalarField > nu() const
Return the laminar viscosity.