| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / 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::Polynomial | |
| Description | |
| Arbitrary order polynomial Function1. | |
| The coefficients in the polynomial are specified in order of increasing | |
| exponent, starting from the constant coefficient (i.e., zero exponent). | |
| For example, the polynomial y = -1 + x^2 + 2x^3 can be specified as: | |
| \verbatim | |
| <name> polynomial (-1 0 1 2); | |
| \endverbatim | |
| Or, alternatively: | |
| \verbatim | |
| <name> | |
| { | |
| type polynomial; | |
| coeffs (-1 0 1 2); | |
| } | |
| \endverbatim | |
| SourceFiles | |
| Polynomial1.C | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| namespace Function1s | |
| { | |
| /*---------------------------------------------------------------------------*\ | |
| Class Polynomial Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| template<class Type> | |
| class Polynomial | |
| : | |
| public FieldFunction1<Type, Polynomial<Type>> | |
| { | |
| // Private Data | |
| //- Polynomial coefficients | |
| const List<Type> coeffs_; | |
| // Private Member Functions | |
| //- Do unit conversions on input data | |
| static List<Type> convertRead(const unitSets&, List<Type>); | |
| //- Do unit conversions in order to output data | |
| static List<Type> convertWrite(const unitSets&, List<Type>); | |
| public: | |
| //- Runtime type information | |
| TypeName("polynomial"); | |
| // Constructors | |
| //- Construct from name and dictionary | |
| Polynomial | |
| ( | |
| const word& name, | |
| const unitSets& units, | |
| const dictionary& dict | |
| ); | |
| //- Construct from name and Istream | |
| Polynomial | |
| ( | |
| const word& name, | |
| const unitSets& units, | |
| Istream& is | |
| ); | |
| //- Copy constructor | |
| Polynomial(const Polynomial& poly); | |
| //- Destructor | |
| virtual ~Polynomial(); | |
| // Member Functions | |
| //- Return the value at a scalar coordinate | |
| virtual inline Type value(const scalar x) const; | |
| //- Return the derivative at a scalar coordinate | |
| 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; | |
| //- Write in dictionary format | |
| virtual void write(Ostream& os, const unitSets& units) const; | |
| // Member Operators | |
| //- Disallow default bitwise assignment | |
| void operator=(const Polynomial<Type>&) = delete; | |
| }; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace Function1s | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |