OpenFOAM: API Guide
v2006
The open source CFD toolbox
minMaxConditionTemplates.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) 2015 OpenFOAM Foundation
9
Copyright (C) 2015-2016 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
// * * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * //
30
31
template
<
class
Type>
32
void
Foam::functionObjects::runTimeControls::minMaxCondition::setValue
33
(
34
const
word
& valueType,
35
const
word
& fieldName,
36
scalar& value
37
)
const
38
{
39
if
(
pTraits<Type>::typeName
!= valueType)
40
{
41
return
;
42
}
43
44
Type v = state_.getObjectResult<Type>(functionObjectName_, fieldName);
45
value =
mag
(v);
46
}
47
48
49
// ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition:
word.H:62
Foam::pTraits
Traits class for primitives.
Definition:
pTraits.H:54
Foam::mag
dimensioned< typename typeOfMag< Type >::type > mag(const dimensioned< Type > &dt)
Foam::functionObjects::runTimeControls::minMaxCondition::setValue
void setValue(const word &valueType, const word &fieldName, scalar &value) const
Helper function to retrieve the value from the state dictionary.
Definition:
minMaxConditionTemplates.C:33
src
functionObjects
utilities
runTimeControl
runTimeCondition
minMaxCondition
minMaxConditionTemplates.C
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.