0b4643922a
Function1 is an abstract base-class of run-time selectable unary functions which may be composed of other Function1's allowing the user to specify complex functions of a single scalar variable, e.g. time. The implementations need not be a simple or continuous functions; interpolated tables and polynomials are also supported. In fact form of mapping between a single scalar input and a single primitive type output is supportable. The primary application of Function1 is in time-varying boundary conditions, it also used for other functions of time, e.g. injected mass is spray simulations but is not limited to functions of time.
170 lines
4.3 KiB
C++
170 lines
4.3 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-2016 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::Function1Types::PolynomialEntry
|
|
|
|
Description
|
|
PolynomialEntry container data entry for scalars. Items are stored in a
|
|
list of Tuple2's. Data is input in the form,
|
|
e.g. for an entry \<entryName\> that describes y = x^2 + 2x^3
|
|
|
|
\verbatim
|
|
<entryName> polynomial
|
|
(
|
|
(1 2)
|
|
(2 3)
|
|
);
|
|
\endverbatim
|
|
|
|
SourceFiles
|
|
PolynomialEntry.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef PolynomialEntry_H
|
|
#define PolynomialEntry_H
|
|
|
|
#include "Function1.H"
|
|
#include "Tuple2.H"
|
|
#include "Function1Fwd.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
// Forward declaration of friend functions and operators
|
|
namespace Function1Types
|
|
{
|
|
template<class Type> class Polynomial;
|
|
};
|
|
|
|
template<class Type>
|
|
Ostream& operator<<(Ostream&, const Function1Types::Polynomial<Type>&);
|
|
|
|
namespace Function1Types
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class Polynomial Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
template<class Type>
|
|
class Polynomial
|
|
:
|
|
public Function1<Type>
|
|
{
|
|
// Private data
|
|
|
|
//- Polynomial coefficients - list of prefactor, exponent
|
|
List<Tuple2<Type, Type>> coeffs_;
|
|
|
|
//- Flag to indicate whether poly can be integrated
|
|
bool canIntegrate_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const Polynomial<Type>&);
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("polynomial");
|
|
|
|
|
|
// Constructors
|
|
|
|
Polynomial(const word& entryName, const dictionary& dict);
|
|
|
|
//- Construct from components
|
|
Polynomial
|
|
(
|
|
const word& entryName,
|
|
const List<Tuple2<Type, Type>>&
|
|
);
|
|
|
|
//- Copy constructor
|
|
Polynomial(const Polynomial& poly);
|
|
|
|
//- Construct and return a clone
|
|
virtual tmp<Function1<Type>> clone() const
|
|
{
|
|
return tmp<Function1<Type>>(new Polynomial(*this));
|
|
}
|
|
|
|
|
|
//- Destructor
|
|
virtual ~Polynomial();
|
|
|
|
|
|
// Member Functions
|
|
|
|
// Manipulation
|
|
|
|
//- Convert time
|
|
virtual void convertTimeBase(const Time& t);
|
|
|
|
|
|
// Evaluation
|
|
|
|
//- Return Polynomial value
|
|
Type value(const scalar x) const;
|
|
|
|
//- Integrate between two (scalar) values
|
|
Type integrate(const scalar x1, const scalar x2) const;
|
|
|
|
|
|
// I/O
|
|
|
|
//- Ostream Operator
|
|
friend Ostream& operator<< <Type>
|
|
(
|
|
Ostream& os,
|
|
const Polynomial<Type>& cnst
|
|
);
|
|
|
|
//- Write in dictionary format
|
|
virtual void writeData(Ostream& os) const;
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Function1Types
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#ifdef NoRepository
|
|
# include "PolynomialEntry.C"
|
|
#endif
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|