File size: 3,956 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 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 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 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 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
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/>.
Class
Foam::Function1s::Constant
Description
Templated function that returns a constant value.
Usage
For entry \<name\> returning the value <value>:
\verbatim
<name> constant <value>
\endverbatim
SourceFiles
Constant.C
\*---------------------------------------------------------------------------*/
#ifndef Constant_H
#define Constant_H
#include "Function1.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace Function1s
{
/*---------------------------------------------------------------------------*\
Class Constant Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class Constant
:
public FieldFunction1<Type, Constant<Type>>
{
// Private Data
//- Constant value
Type value_;
public:
// Runtime type information
TypeName("constant");
// Constructors
//- Construct from name and value
Constant(const word& name, const Type& val);
//- Construct from name and dictionary
Constant
(
const word& name,
const unitSets& units,
const dictionary& dict
);
//- Construct from name and Istream
Constant(const word& name, const unitSets& units, Istream& is);
//- Copy constructor
Constant(const Constant<Type>& cnst);
//- Construct and return a clone
virtual tmp<Function1<Type>> clone() const
{
return tmp<Function1<Type>>(new Constant<Type>(*this));
}
//- Destructor
virtual ~Constant();
// Member Functions
//- Return constant value
virtual inline Type value(const scalar) const;
//- Return zero
virtual inline Type derivative(const scalar x) const;
//- Return the integral between two scalar coordinates
virtual inline Type integral(const scalar x1, const scalar x2) const;
//- Is this function guaranteed to be constant?
virtual inline bool constant() const;
//- Write in dictionary format
virtual void write(Ostream& os, const unitSets& units) const;
// Member Operators
//- Copy assignment
void operator=(const Constant<Type>&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Function1s
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "ConstantI.H"
#ifdef NoRepository
#include "Constant.C"
#include "Function1New.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|