src/foam/primitives/FadOne/FadOne.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     |
   5     \\  /    A nd           | For copyright notice see file Copyright
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     FadOne
  26
  27 Description
  28     Forward automatic derivative of the first order.  Supports multi-variable
  29     derivative, where the number of independent variables is specified at
  30     compile-time.  Replaces scalar in calculations
  31
  32 SourceFiles
  33     FadOneI.H
  34     FadOne.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef FadOne_H
  39 #define FadOne_H
  40
  41 #include "error.H"
  42 #include "IOstream.H"
  43 #include "token.H"
  44
  45 #include "products.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 // * * * * * * Forward declaration of template friend fuctions * * * * * * * //
  53
  54 template<int nVars> class FadOne;
  55
  56 template<int nVars>
  57 inline FadOne<nVars> operator+(const FadOne<nVars>&, const FadOne<nVars>&);
  58
  59 template<int nVars>
  60 inline FadOne<nVars> operator+(const double, const FadOne<nVars>&);
  61
  62 template<int nVars>
  63 inline FadOne<nVars> operator+(const FadOne<nVars>&, const double);
  64
  65 template<int nVars>
  66 inline FadOne<nVars> operator-(const FadOne<nVars>&);
  67
  68 template<int nVars>
  69 inline FadOne<nVars> operator-(const FadOne<nVars>&, const FadOne<nVars>&);
  70
  71 template<int nVars>
  72 inline FadOne<nVars> operator-(const double, const FadOne<nVars>&);
  73
  74 template<int nVars>
  75 inline FadOne<nVars> operator-(const FadOne<nVars>&, const double);
  76
  77 template<int nVars>
  78 inline FadOne<nVars> operator*(const FadOne<nVars>&, const FadOne<nVars>&);
  79
  80 template<int nVars>
  81 inline FadOne<nVars> operator*(const double, const FadOne<nVars>&);
  82
  83 template<int nVars>
  84 inline FadOne<nVars> operator*(const FadOne<nVars>&, const double);
  85
  86 template<int nVars>
  87 inline FadOne<nVars> operator/(const FadOne<nVars>&, const FadOne<nVars>&);
  88
  89 template<int nVars>
  90 inline FadOne<nVars> operator/(const double, const FadOne<nVars>&);
  91
  92 template<int nVars>
  93 inline FadOne<nVars> operator/(const FadOne<nVars>&, const double);
  94
  95 template<int nVars>
  96 inline bool operator<(const FadOne<nVars>&, const FadOne<nVars>&);
  97
  98 template<int nVars>
  99 inline bool operator<=(const FadOne<nVars>&, const FadOne<nVars>&);
 100
 101 template<int nVars>
 102 inline bool operator>(const FadOne<nVars>&, const FadOne<nVars>&);
 103
 104 template<int nVars>
 105 inline bool operator>=(const FadOne<nVars>&, const FadOne<nVars>&);
 106
 107 template<int nVars>
 108 inline bool operator==(const FadOne<nVars>&, const FadOne<nVars>&);
 109
 110 template<int nVars>
 111 inline bool operator!=(const FadOne<nVars>&, const FadOne<nVars>&);
 112
 113 template<int nVars>
 114 Istream& operator>>(Istream&, FadOne<nVars>&);
 115
 116 template<int nVars>
 117 Ostream& operator<<(Ostream&, const FadOne<nVars>&);
 118
 119
 120 /*---------------------------------------------------------------------------*\
 121                            Class FadOne Declaration
 122 \*---------------------------------------------------------------------------*/
 123
 124 template<int nVars>
 125 class FadOne
 126 {
 127     // Private data
 128
 129         //- Length of data list
 130         static const label Length = nVars + 1;
 131
 132         //- Value and derivatives
 133         double data_[Length];
 134
 135
 136     // Private Member Functions
 137
 138
 139 public:
 140
 141     //- Component type
 142     typedef FadOne<nVars> cmptType;
 143
 144
 145     // Member constants
 146
 147         enum
 148         {
 149             dim = 3,         // Dimensionality of space
 150             rank = 0,        // Rank od Scalar is 0
 151             nComponents = 1  // Number of components in FadOne is 1
 152         };
 153
 154     // Static data members
 155
 156         static const char* const typeName;
 157         static const char* componentNames[];
 158         static const FadOne<nVars> zero;
 159         static const FadOne<nVars> one;
 160
 161
 162     // Constructors
 163
 164         //- Construct null
 165         inline FadOne();
 166
 167         //- Construct from value
 168         explicit inline FadOne(const double& v);
 169
 170         //- Construct from Istream
 171         explicit inline FadOne(Istream&);
 172
 173         //- Construct as copy
 174         inline FadOne(const FadOne<nVars>&);
 175
 176
 177     // Destructor - default
 178
 179
 180     // Member Functions
 181
 182         //- Return value
 183         inline const double& value() const;
 184         inline double& value();
 185
 186         //- Return derivative
 187         inline const double& deriv(const label i) const;
 188         inline double& deriv(const label i);
 189
 190
 191     // Member Operators
 192
 193         inline void operator=(const double&);
 194         inline void operator=(const FadOne<nVars>&);
 195
 196         inline void operator+=(const double&);
 197         inline void operator+=(const FadOne<nVars>&);
 198         inline void operator-=(const double&);
 199         inline void operator-=(const FadOne<nVars>&);
 200         inline void operator*=(const double&);
 201         inline void operator*=(const FadOne<nVars>&);
 202         inline void operator/=(const double&);
 203         inline void operator/=(const FadOne<nVars>&);
 204
 205
 206     // Friend Functions
 207
 208
 209     // Friend operators
 210
 211         friend FadOne<nVars> operator+ <nVars>
 212         (
 213             const FadOne<nVars>&,
 214             const FadOne<nVars>&
 215         );
 216
 217         friend FadOne<nVars> operator+ <nVars>
 218         (
 219             const double,
 220             const FadOne<nVars>&
 221         );
 222
 223         friend FadOne<nVars> operator+ <nVars>
 224         (
 225             const FadOne<nVars>&,
 226             const double
 227         );
 228
 229         friend FadOne<nVars> operator- <nVars>(const FadOne<nVars>&);
 230
 231         friend FadOne<nVars> operator- <nVars>
 232         (
 233             const FadOne<nVars>&,
 234             const FadOne<nVars>&
 235         );
 236
 237         friend FadOne<nVars> operator- <nVars>
 238         (
 239             const double,
 240             const FadOne<nVars>&
 241         );
 242
 243         friend FadOne<nVars> operator- <nVars>
 244         (
 245             const FadOne<nVars>&,
 246             const double
 247         );
 248
 249         friend FadOne<nVars> operator* <nVars>
 250         (
 251             const FadOne<nVars>&,
 252             const FadOne<nVars>&
 253         );
 254
 255         friend FadOne<nVars> operator* <nVars>
 256         (
 257             const double,
 258             const FadOne<nVars>&
 259         );
 260
 261         friend FadOne<nVars> operator* <nVars>
 262         (
 263             const FadOne<nVars>&,
 264             const double
 265         );
 266
 267         friend FadOne<nVars> operator/ <nVars>
 268         (
 269             const FadOne<nVars>&,
 270             const FadOne<nVars>&
 271         );
 272
 273         friend FadOne<nVars> operator/ <nVars>
 274         (
 275             const double,
 276             const FadOne<nVars>&
 277         );
 278
 279         friend FadOne<nVars> operator/ <nVars>
 280         (
 281             const FadOne<nVars>&,
 282             const double
 283         );
 284
 285         friend bool operator< <nVars>
 286         (
 287             const FadOne<nVars>&,
 288             const FadOne<nVars>&
 289         );
 290
 291         friend bool operator<= <nVars>
 292         (
 293             const FadOne<nVars>&,
 294             const FadOne<nVars>&
 295         );
 296
 297         friend bool operator> <nVars>
 298         (
 299             const FadOne<nVars>&,
 300             const FadOne<nVars>&
 301         );
 302
 303         friend bool operator>= <nVars>
 304         (
 305             const FadOne<nVars>&,
 306             const FadOne<nVars>&
 307         );
 308
 309         friend bool operator== <nVars>
 310         (
 311             const FadOne<nVars>&,
 312             const FadOne<nVars>&
 313         );
 314
 315         friend bool operator!= <nVars>
 316         (
 317             const FadOne<nVars>&,
 318             const FadOne<nVars>&
 319         );
 320
 321
 322     // IOstream Operators
 323
 324         friend Istream& operator>> <nVars>(Istream&, FadOne<nVars>&);
 325         friend Ostream& operator<< <nVars>(Ostream&, const FadOne<nVars>&);
 326 };
 327
 328
 329 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 330
 331 } // End namespace Foam
 332
 333 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 334
 335 #include "FadOneI.H"
 336 #include "FadOne.C"
 337 #include "FadOneFunctions.H"
 338 #include "FadOneFunctionsI.H"
 339
 340 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 341
 342 #endif
 343
 344 // ************************************************************************* //