src/equationReader/equation/equation.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   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     Foam::equation
  26
  27 Description
  28     An equation, read from a dictionary.  Effectively just a container class
  29     holding all data associated with an individual equation.  Functions are
  30     implemented in masterDictionary.
  31
  32 SourceFiles
  33     equationI.H
  34     equation.C
  35     equationIO.C
  36
  37 Author
  38     David L. F. Gaden
  39
  40 \*---------------------------------------------------------------------------*/
  41
  42 #ifndef equation_H
  43 #define equation_H
  44
  45 //#include "equationOperationList.H"
  46 //#include "dimensionedScalar.H"
  47 #include "scalarField.H"
  48 #include "dimensionSet.H"
  49 #include "equationOperation.H"
  50
  51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  52
  53 namespace Foam
  54 {
  55
  56 // Forward declaration of friend functions and operators
  57
  58 class equation;
  59
  60 // Friend IOstream Operators
  61
  62 Istream& operator>>(Istream&, equation&);
  63 Ostream& operator<<(Ostream&, const equation&);
  64
  65 /*---------------------------------------------------------------------------*\
  66                         Class equation Declaration
  67 \*---------------------------------------------------------------------------*/
  68
  69 class equation
  70 {
  71
  72     // Private data
  73
  74         word equationName_;
  75
  76         //- Operation list
  77         mutable PtrList<equationOperation> ops_;
  78
  79         //- raw text read from the dictionary
  80         mutable string rawText_;
  81
  82         //- Result of most recent evaluate() or update()
  83         mutable dimensionedScalar lastResult_;
  84
  85         //- Override dimensions - if read from a dictionary with dimensions,
  86         //  eg:  nu      nu [0 2 -1 0 0 0 0] "sin(theta)";
  87         //  the dimensionedScalar resulting from evaluate() is given these
  88         //  dimensions
  89         mutable dimensionSet overrideDimensions_;
  90
  91         //- true if there is a dimension override
  92         mutable bool changeDimensions_;
  93
  94         //- Maximum field size of output, indexed by geoIndex
  95         mutable labelList maxFieldSizes_;
  96
  97     // Private member functions
  98
  99         //- Disallow default bitwise assignment
 100         void operator=(const equation&);
 101
 102 public:
 103
 104     // Static data members
 105
 106         static const char* const typeName;
 107
 108
 109     // Constructors
 110
 111         //- Construct null
 112         equation();
 113
 114         //- Construct copy
 115         equation(const equation&);
 116
 117         //- Construct from Istream with optional name
 118         equation(Istream& is, const word& name = word::null);
 119
 120         //- Construct from components
 121         equation
 122         (
 123             const word& equationName,
 124             const string& rawText,
 125             const dimensionSet& overrideDimensions = dimless,
 126             const bool& changeDimensions = false
 127         );
 128
 129     // Destructor
 130     ~equation();
 131
 132     // Member functions
 133
 134         // Access
 135
 136             //- Equation name
 137             inline const word& name() const;
 138
 139             //- Size of operation list
 140             inline label size() const;
 141
 142             //- setSize of operation list
 143             inline void setSize(const label newSize) const;
 144
 145             //- set an element of operation list
 146             inline autoPtr<equationOperation> set
 147             (
 148                 const label elementIndex,
 149                 equationOperation * newOperation
 150             ) const;
 151
 152             //- Change the equation name
 153             inline word& name();
 154
 155             //- Equation text
 156             inline const string& rawText() const;
 157
 158             //- Set equation text
 159             inline void setRawText(const string& newRawText) const;
 160
 161             //- Last result
 162             inline const dimensionedScalar& lastResult() const;
 163
 164             //- Set the last result
 165             inline void setLastResult
 166             (
 167                 const dimensionedScalar& newResult
 168             ) const;
 169
 170             //- Set the value of the last result
 171             inline void setLastResult(const word& newName) const;
 172
 173             //- Set the dimensions of the last result
 174             inline void setLastResult(const dimensionSet& newDims) const;
 175
 176             //- Set the value of the last result
 177             inline void setLastResult(const scalar& newScalar) const;
 178
 179             //- Dimension override
 180             inline const dimensionSet& overrideDimensions() const;
 181
 182             //- Set override dimensions
 183             inline void setOverrideDimensions
 184             (
 185                 const dimensionSet& newDims
 186             ) const;
 187
 188             //- changeDimensions flag
 189             inline const bool& changeDimensions() const;
 190
 191             //- Set the changeDimensions flag
 192             inline void setChangeDimensions(bool newFlag) const;
 193
 194             //- Return maxFieldSizes
 195             inline const labelList& maxFieldSizes() const;
 196
 197             //- Set maxFieldSizes
 198             inline void setMaxFieldSizes
 199             (
 200                 const labelList& newSizes
 201             ) const;
 202
 203     // Delete the operation list
 204     void clear() const;
 205
 206     // Operators
 207
 208         //- Copy only the header info - rawText, equationName,
 209         // dimensionOverride, and changeDimensions
 210         void operator=(equation&);
 211
 212         //- Access to ops_
 213         inline equationOperation& operator[](const label) const;
 214
 215     // Friend IOstream Operators
 216
 217         friend Istream& operator>>(Istream&, equation&);
 218         friend Ostream& operator<<(Ostream&, const equation&);
 219
 220 };
 221
 222
 223 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 224
 225 } // End namespace Foam
 226
 227 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 228
 229 #include "equationI.H"
 230
 231 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 232
 233 #endif
 234
 235 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //