src/lagrangian/intermediate/submodels/IO/DataEntry/polynomial/polynomial.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::polynomial
  27
  28 Description
  29     Polynomial container data entry for scalars. Items are stored in a list of
  30     Tuple2's. Data is input in the form, e.g. for an entry <entryName> that
  31     describes y = x^2 + 2x^3
  32
  33     @verbatim
  34         <entryName>   polynomial
  35         (
  36             (1    2)
  37             (2    3)
  38         );
  39     @endverbatim
  40
  41 SourceFiles
  42     polynomial.C
  43
  44 \*---------------------------------------------------------------------------*/
  45
  46 #ifndef polynomial_H
  47 #define polynomial_H
  48
  49 #include "DataEntry.H"
  50 #include "Tuple2.H"
  51
  52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  53
  54 namespace Foam
  55 {
  56
  57 // Forward declaration of classes
  58 class polynomial;
  59
  60 // Forward declaration of friend functions
  61 Ostream& operator<<
  62 (
  63     Ostream&,
  64     const polynomial&
  65 );
  66
  67 /*---------------------------------------------------------------------------*\
  68                         Class polynomial Declaration
  69 \*---------------------------------------------------------------------------*/
  70
  71 class polynomial
  72 :
  73     public DataEntry<scalar>
  74 {
  75     // Private data
  76
  77         //- Polynomial coefficients - list of prefactor, exponent
  78         List<Tuple2<scalar, scalar> > coeffs_;
  79
  80
  81     // Private Member Functions
  82
  83         //- Disallow default bitwise assignment
  84         void operator=(const polynomial&);
  85
  86
  87 public:
  88
  89     //- Runtime type information
  90     TypeName("polynomial");
  91
  92
  93     // Constructors
  94
  95         //- Construct from entry name and Istream
  96         polynomial(const word& entryName, Istream& is);
  97
  98         //- Copy constructor
  99         polynomial(const polynomial& poly);
 100
 101
 102     //- Destructor
 103     virtual ~polynomial();
 104
 105
 106     // Member Functions
 107
 108         //- Return polynomial value
 109         scalar value(const scalar x) const;
 110
 111         //- Integrate between two (scalar) values
 112         scalar integrate(const scalar x1, const scalar x2) const;
 113
 114
 115     //- Ostream Operator
 116     friend Ostream& operator<<
 117     (
 118         Ostream&,
 119         const polynomial&
 120     );
 121 };
 122
 123
 124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 125
 126 } // End namespace Foam
 127
 128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 129
 130 #endif
 131
 132 // ************************************************************************* //