strainRateFunction.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2016-2017 OpenFOAM Foundation
9  Copyright (C) 2017 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "strainRateFunction.H"
31 #include "surfaceFields.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37 namespace viscosityModels
38 {
39  defineTypeNameAndDebug(strainRateFunction, 0);
40 
42  (
43  viscosityModel,
44  strainRateFunction,
45  dictionary
46  );
47 }
48 }
49 
50 
51 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
52 
54 (
55  const word& name,
56  const dictionary& viscosityProperties,
57  const volVectorField& U,
58  const surfaceScalarField& phi
59 )
60 :
61  viscosityModel(name, viscosityProperties, U, phi),
62  strainRateFunctionCoeffs_
63  (
64  viscosityProperties.optionalSubDict(typeName + "Coeffs")
65  ),
66  strainRateFunction_
67  (
68  Function1<scalar>::New("function", strainRateFunctionCoeffs_)
69  ),
70  nu_
71  (
72  IOobject
73  (
74  name,
75  U_.time().timeName(),
76  U_.db(),
77  IOobject::NO_READ,
78  IOobject::AUTO_WRITE
79  ),
80  U_.mesh(),
82  )
83 {
84  correct();
85 }
86 
87 
88 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
89 
92 {
93  return nu_;
94 }
95 
96 
99 {
100  return nu_.boundaryField()[patchi];
101 }
102 
103 
105 {
106  tmp<volScalarField> tsigma = strainRate();
107  const volScalarField& sigma = tsigma();
108 
109  nu_.primitiveFieldRef() = strainRateFunction_->value(sigma());
110 
111  volScalarField::Boundary& nuBf = nu_.boundaryFieldRef();
112  const volScalarField::Boundary& sigmaBf = sigma.boundaryField();
113 
114  forAll(nuBf, patchi)
115  {
116  nuBf[patchi] = strainRateFunction_->value(sigmaBf[patchi]);
117  }
118 }
119 
120 
122 (
123  const dictionary& viscosityProperties
124 )
125 {
126  viscosityModel::read(viscosityProperties);
127 
128  strainRateFunctionCoeffs_ = viscosityProperties.optionalSubDict
129  (
130  typeName + "Coeffs"
131  );
132 
133  strainRateFunction_.clear();
134  strainRateFunction_ = Function1<scalar>::New
135  (
136  "function",
137  strainRateFunctionCoeffs_
138  );
139 
140  return true;
141 }
142 
143 
144 // ************************************************************************* //
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:104
Foam::viscosityModel
An abstract base class for incompressible viscosityModels.
Definition: viscosityModel.H:67
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::Zero
static constexpr const zero Zero
Global zero (0)
Definition: zero.H:131
surfaceFields.H
Foam::surfaceFields.
Foam::Function1
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: Function1.H:86
forAll
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:296
Foam::viscosityModel::read
virtual bool read(const dictionary &viscosityProperties)=0
Read transportProperties dictionary.
Definition: viscosityModel.C:66
Foam::viscosityModels::strainRateFunction::strainRateFunction
strainRateFunction(const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
Construct from components.
Definition: strainRateFunction.C:54
Foam::name
word name(const complex &c)
Return string representation of complex.
Definition: complex.C:76
correct
fvOptions correct(rho)
Foam::dimensionedScalar
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
Definition: dimensionedScalarFwd.H:43
phi
surfaceScalarField & phi
Definition: setRegionFluidFields.H:8
Foam::viscosityModels::defineTypeNameAndDebug
defineTypeNameAndDebug(BirdCarreau, 0)
Foam::dimViscosity
const dimensionSet dimViscosity
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
strainRateFunction.H
U
U
Definition: pEqn.H:72
Foam::viscosityModels::strainRateFunction::nu_
volScalarField nu_
Definition: strainRateFunction.H:86
Foam::viscosityModels::strainRateFunction::correct
virtual void correct()
Correct the laminar viscosity.
Definition: strainRateFunction.C:104
Foam::viscosityModels::strainRateFunction::nu
virtual tmp< volScalarField > nu() const
Return the laminar viscosity.
Definition: strainRateFunction.C:91
Foam::dictionary::optionalSubDict
const dictionary & optionalSubDict(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Find and return a sub-dictionary, otherwise return this dictionary.
Definition: dictionary.C:645
sigma
dimensionedScalar sigma("sigma", dimMass/sqr(dimTime), transportProperties)
Foam::viscosityModels::strainRateFunction::read
virtual bool read(const dictionary &viscosityProperties)
Read transportProperties dictionary.
Definition: strainRateFunction.C:122
Foam::GeometricField< vector, fvPatchField, volMesh >
Foam::dictionary::clear
void clear()
Clear the dictionary.
Definition: dictionary.C:924
Foam::viscosityModels::addToRunTimeSelectionTable
addToRunTimeSelectionTable(viscosityModel, BirdCarreau, dictionary)