Newer
Older
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | www.openfoam.com
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2018-2019 OpenFOAM Foundation
Copyright (C) 2020-2021 OpenCFD Ltd.
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\*---------------------------------------------------------------------------*/
#include "log.H"
#include "volFields.H"
#include "addToRunTimeSelectionTable.H"
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
defineTypeNameAndDebug(log, 0);
addToRunTimeSelectionTable(functionObject, log, dictionary);
}
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
bool Foam::functionObjects::log::calc()
{
if (foundObject<volScalarField>(fieldName_))
{
const volScalarField& x = lookupObject<volScalarField>(fieldName_);
// Switch-off dimension checking if requested
const bool oldDimChecking = dimensionSet::checking();
if (!checkDimensions_)
{
dimensionSet::checking(false);
}
bool stored = store
(
resultName_,
scale_*Foam::log(max(x, clipValue_)) + offset_
);
// Reinstate dimension checking
if (!checkDimensions_)
{
dimensionSet::checking(oldDimChecking);
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
}
return stored;
}
return false;
}
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
Foam::functionObjects::log::log
(
const word& name,
const Time& runTime,
const dictionary& dict
)
:
fieldExpression(name, runTime, dict, typeName),
checkDimensions_(true),
clipValue_(SMALL),
scale_(1.0),
offset_(0.0)
{
read(dict);
}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
bool Foam::functionObjects::log::read(const dictionary& dict)
{
if (fvMeshFunctionObject::read(dict) && fieldExpression::read(dict))
{
checkDimensions_ = dict.getOrDefault<Switch>("checkDimensions", true);
clipValue_ =
dict.getCheckOrDefault<scalar>
(
"clip",
SMALL,
scalarMinMax::ge(SMALL)
);
scale_ = dict.getOrDefault<scalar>("scale", 1.0);
offset_ = dict.getOrDefault<scalar>("offset", 0.0);
return true;
}
return false;
}
// ************************************************************************* //