noneThermophysicalFunction.H
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) 2019-2020 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 Class
25  Foam::thermophysicalFunctions::none
26 
27 Description
28  Undefined function which returns an error when called.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef noneThermophysicalFunction_H
33 #define noneThermophysicalFunction_H
34 
35 #include "thermophysicalFunction.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 namespace thermophysicalFunctions
42 {
43 
44 /*---------------------------------------------------------------------------*\
45  Class none Declaration
46 \*---------------------------------------------------------------------------*/
47 
48 class none
49 :
51 {
52  // Private member data
53 
54  //- Name of dictionary from which this function is instantiated
55  fileName dictName_;
56 
57 
58 public:
59 
60  //- Runtime type information
61  TypeName("none");
62 
63 
64  // Constructors
65 
66  //- Construct from dictionary
67  none(const dictionary& dict);
68 
69 
70  // Member Functions
71 
72  //- Evaluate the function and return the result
73  scalar f(scalar p, scalar T) const;
74 
75  //- Write the function coefficients
76  void write(Ostream& os) const;
77 };
78 
79 
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 
82 } // End namespace thermophysicalFunctions
83 } // End namespace Foam
84 
85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86 
87 #endif
88 
89 // ************************************************************************* //
dictionary dict
A class for handling file names.
Definition: fileName.H:79
scalar f(scalar p, scalar T) const
Evaluate the function and return the result.
void write(Ostream &os) const
Write the function coefficients.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
none(const dictionary &dict)
Construct from dictionary.
Abstract base class for thermo-physical functions.
TypeName("none")
Runtime type information.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
volScalarField & p
Undefined function which returns an error when called.
Namespace for OpenFOAM.