144 lines
3.8 KiB
C++
144 lines
3.8 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011 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::CompatibilityConstant
|
|
|
|
Description
|
|
Templated basic entry that holds a constant value for backwards
|
|
compatibility (when DataEntry type is not present)
|
|
|
|
Usage - for entry \<entryName\> having the value <value>:
|
|
\verbatim
|
|
<entryName> <value>
|
|
\endverbatim
|
|
|
|
SourceFiles
|
|
CompatibilityConstant.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef CompatibilityConstant_H
|
|
#define CompatibilityConstant_H
|
|
|
|
#include "DataEntry.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
template<class Type>
|
|
class CompatibilityConstant;
|
|
|
|
template<class Type>
|
|
Ostream& operator<<(Ostream&, const CompatibilityConstant<Type>&);
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class CompatibilityConstant Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
template<class Type>
|
|
class CompatibilityConstant
|
|
:
|
|
public DataEntry<Type>
|
|
{
|
|
// Private data
|
|
|
|
//- Constant value
|
|
Type value_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const CompatibilityConstant<Type>&);
|
|
|
|
|
|
public:
|
|
|
|
// Runtime type information
|
|
TypeName("CompatibilityConstant");
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from entry name and Istream
|
|
CompatibilityConstant(const word& entryName, const dictionary& dict);
|
|
|
|
//- Copy constructor
|
|
CompatibilityConstant(const CompatibilityConstant<Type>& cnst);
|
|
|
|
//- Construct and return a clone
|
|
virtual tmp<DataEntry<Type> > clone() const
|
|
{
|
|
return tmp<DataEntry<Type> >
|
|
(
|
|
new CompatibilityConstant<Type>(*this)
|
|
);
|
|
}
|
|
|
|
|
|
//- Destructor
|
|
virtual ~CompatibilityConstant();
|
|
|
|
|
|
// Member Functions
|
|
|
|
//- Return constant value
|
|
Type value(const scalar) const;
|
|
|
|
//- Integrate between two values
|
|
Type integrate(const scalar x1, const scalar x2) const;
|
|
|
|
|
|
// I/O
|
|
|
|
//- Ostream Operator
|
|
friend Ostream& operator<< <Type>
|
|
(
|
|
Ostream& os,
|
|
const CompatibilityConstant<Type>& cnst
|
|
);
|
|
|
|
//- Write in dictionary format
|
|
virtual void writeData(Ostream& os) const;
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#ifdef NoRepository
|
|
# include "CompatibilityConstant.C"
|
|
#endif
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|