singlePhaseTransportModel.C
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-2015 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 
31 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
32 
34 (
35  const volVectorField& U,
36  const surfaceScalarField& phi
37 )
38 :
40  (
41  IOobject
42  (
43  "transportProperties",
44  U.time().constant(),
45  U.db(),
46  IOobject::MUST_READ_IF_MODIFIED,
47  IOobject::NO_WRITE
48  )
49  ),
50  viscosityModelPtr_(viscosityModel::New("nu", *this, U, phi))
51 {}
52 
53 
54 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
55 
57 {}
58 
59 
60 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
61 
64 {
65  return viscosityModelPtr_->nu();
66 }
67 
68 
71 {
72  return viscosityModelPtr_->nu(patchi);
73 }
74 
75 
77 {
78  viscosityModelPtr_->correct();
79 }
80 
81 
83 {
84  if (regIOobject::read())
85  {
86  return viscosityModelPtr_->read(*this);
87  }
88  else
89  {
90  return false;
91  }
92 }
93 
94 
95 // ************************************************************************* //
volFields.H
Foam::IOdictionary
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:53
Foam::IOobject
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:91
Foam::compressible::New
autoPtr< BasicCompressibleTurbulenceModel > New(const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const typename BasicCompressibleTurbulenceModel::transportModel &transport, const word &propertiesName)
Definition: turbulentFluidThermoModel.C:36
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:118
singlePhaseTransportModel.H
phi
surfaceScalarField & phi
Definition: setRegionFluidFields.H:8
Foam::regIOobject::read
virtual bool read()
Read object.
Definition: regIOobjectRead.C:171
Foam::singlePhaseTransportModel::read
virtual bool read()
Read transportProperties dictionary.
Definition: singlePhaseTransportModel.C:82
U
U
Definition: pEqn.H:46
Foam::label
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
Foam::singlePhaseTransportModel::singlePhaseTransportModel
singlePhaseTransportModel(const singlePhaseTransportModel &)
Disallow copy construct.
Foam::singlePhaseTransportModel::nu
virtual tmp< volScalarField > nu() const
Return the laminar viscosity.
Definition: singlePhaseTransportModel.C:63
patchi
label patchi
Definition: getPatchFieldScalar.H:1
Foam::singlePhaseTransportModel::~singlePhaseTransportModel
virtual ~singlePhaseTransportModel()
Destructor.
Definition: singlePhaseTransportModel.C:56
Foam::singlePhaseTransportModel::correct
virtual void correct()
Correct the laminar viscosity.
Definition: singlePhaseTransportModel.C:76
Foam::GeometricField
Generic GeometricField class.
Definition: surfaceFieldsFwd.H:52