OpenFOAM
v2406
The open source CFD toolbox
NoneFunction1.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) 2021 OpenCFD Ltd.
9
-------------------------------------------------------------------------------
10
License
11
This file is part of OpenFOAM.
12
13
OpenFOAM is free software: you can redistribute it and/or modify it
14
under the terms of the GNU General Public License as published by
15
the Free Software Foundation, either version 3 of the License, or
16
(at your option) any later version.
17
18
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21
for more details.
22
23
You should have received a copy of the GNU General Public License
24
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26
\*---------------------------------------------------------------------------*/
27
28
#include "
NoneFunction1.H
"
29
30
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
31
32
template
<
class
Type>
33
Foam::Function1Types::None<Type>::None
34
(
35
const
word
& entryName,
36
const
dictionary
&
dict
,
37
const
objectRegistry
* obrPtr
38
)
39
:
40
Function1
<Type>(entryName,
dict
, obrPtr),
41
context_(
dict
.relativeName())
42
{}
43
44
45
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
46
47
template
<
class
Type>
48
Type
Foam::Function1Types::None<Type>::value
(
const
scalar)
const
49
{
50
FatalErrorInFunction
51
<<
"Function "
<< this->
name
() <<
" is 'none' in "
<< context_ <<
nl
52
<<
exit
(
FatalError
);
53
54
return
pTraits<Type>::zero
;
55
}
56
57
58
template
<
class
Type>
59
Type
Foam::Function1Types::None<Type>::integral
60
(
61
const
scalar x1,
62
const
scalar x2
63
)
64
const
65
{
66
FatalErrorInFunction
67
<<
"Function "
<< this->
name
() <<
" is 'none' in "
<< context_ <<
nl
68
<<
exit
(
FatalError
);
69
70
return
pTraits<Type>::zero
;
71
}
72
73
74
template
<
class
Type>
75
Foam::tmp<Foam::Field<Type>
>
Foam::Function1Types::None<Type>::value
76
(
77
const
scalarField
&
x
78
)
const
79
{
80
FatalErrorInFunction
81
<<
"Function "
<< this->
name
() <<
" is 'none' in "
<< context_ <<
nl
82
<<
exit
(
FatalError
);
83
84
return
nullptr
;
85
}
86
87
88
template
<
class
Type>
89
void
Foam::Function1Types::None<Type>::writeData
(
Ostream
&
os
)
const
90
{
91
// OR: os.writeEntry(this->name(), this->type());
92
Function1<Type>::writeData
(
os
);
93
os
.endEntry();
94
}
95
96
97
// ************************************************************************* //
Foam::Function1
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition:
propellerInfo.H:287
dict
dictionary dict
Definition:
searchingEngine.H:11
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition:
errorManip.H:125
Foam::FatalError
error FatalError
Error stream (stdout output on all processes), with additional 'FOAM FATAL ERROR' header text and sta...
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition:
dictionary.H:129
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition:
error.H:608
Foam::Function1Types::None::None
None(const None< Type > &)=default
Default copy construct.
Foam::nl
constexpr char nl
The newline '\n' character (0x0a)
Definition:
Ostream.H:50
Foam::pTraits
A traits class, which is primarily used for primitives and vector-space.
Definition:
pTraits.H:75
Foam::Function1Types::None::value
virtual Type value(const scalar x) const
Placeholder: generates an error if called.
Definition:
NoneFunction1.C:41
writeData
const bool writeData(pdfDictionary.get< bool >("writeData"))
x
x
Definition:
LISASMDCalcMethod2.H:52
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID.
Definition:
exprTraits.C:127
Foam::Field< scalar >
Foam::word
A class for handling words, derived from Foam::string.
Definition:
word.H:63
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition:
Ostream.H:56
Foam::Function1Types::None::writeData
virtual void writeData(Ostream &os) const
Write as primitive (inline) format.
Definition:
NoneFunction1.C:82
os
OBJstream os(runTime.globalPath()/outputName)
Foam::Function1Types::None::integral
virtual Type integral(const scalar x1, const scalar x2) const
Placeholder: generates an error if called.
Definition:
NoneFunction1.C:53
NoneFunction1.H
Foam::tmp
A class for managing temporary objects.
Definition:
HashPtrTable.H:50
Foam::objectRegistry
Registry of regIOobjects.
Definition:
objectRegistry.H:53
src
OpenFOAM
primitives
functions
Function1
None
NoneFunction1.C
Generated by
1.8.14