All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
None2.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2020-2024 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 
26 #include "None2.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class Type>
32 :
33  FieldFunction2<Type, None<Type>>(name),
34  dictName_("unknown")
35 {}
36 
37 
38 template<class Type>
40 (
41  const word& name,
42  const unitConversions& units,
43  const dictionary& dict
44 )
45 :
46  FieldFunction2<Type, None<Type>>(name),
47  dictName_(dict.name())
48 {}
49 
50 
51 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
52 
53 template<class Type>
55 {}
56 
57 
58 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
59 
60 template<class Type>
61 Type Foam::Function2s::None<Type>::value(const scalar, const scalar) const
62 {
64  << "Required function " << this->name() << " in " << nl
65  << " " << dictName_ << nl
66  << " is not defined."
67  << exit(FatalError);
68 
69  return pTraits<Type>::zero;
70 }
71 
72 
73 template<class Type>
75 (
76  Ostream& os,
77  const unitConversions& units
78 ) const
79 {}
80 
81 
82 // ************************************************************************* //
Undefined Function2 which returns an error when called.
Definition: None2.H:51
virtual ~None()
Destructor.
Definition: None2.C:54
virtual void write(Ostream &os, const unitConversions &units) const
Write in dictionary format.
Definition: None2.C:75
None(const word &name)
Construct from name.
Definition: None2.C:31
virtual Type value(const scalar x, const scalar y) const
Generates an error.
Definition: None2.C:61
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Traits class for primitives.
Definition: pTraits.H:53
A class for handling words, derived from string.
Definition: word.H:62
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:334
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39
const HashTable< unitConversion > & units()
Get the table of unit conversions.
error FatalError
static const char nl
Definition: Ostream.H:266
dictionary dict