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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
   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::Table
  27
  28 Description
  29     Templated table container data entry. Items are stored in a list of
  30     Tuple2's. First column is always stored as scalar entries. Data is read
  31     in the form, e.g. for (scalar, vector):
  32
  33     @verbatim
  34         entry                    Table
  35         entryCoeffs
  36         {
  37             table
  38             (
  39                 0.0 (1 2 3)
  40                 1.0 (4 5 6)
  41             )
  42         }
  43     @endverbatim
  44
  45 SourceFiles
  46     Table.C
  47
  48 \*---------------------------------------------------------------------------*/
  49
  50 #ifndef Table_H
  51 #define Table_H
  52
  53 #include "DataEntry.H"
  54 #include "Tuple2.H"
  55
  56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  57
  58 namespace Foam
  59 {
  60
  61 /*---------------------------------------------------------------------------*\
  62                            Class Table Declaration
  63 \*---------------------------------------------------------------------------*/
  64
  65 template<class Type>
  66 class Table
  67 :
  68     public DataEntry<Type>
  69 {
  70     // Private data
  71
  72        //- Table data
  73        List<Tuple2<scalar, Type> > table_;
  74
  75
  76     // Private Member Functions
  77
  78         //- Disallow default bitwise copy construct
  79         Table(const Table<Type>&);
  80
  81         //- Disallow default bitwise assignment
  82         void operator=(const Table<Type>&);
  83
  84
  85 public:
  86
  87     // Runtime type information
  88     TypeName("Table");
  89
  90
  91     // Constructors
  92
  93         //- Construct from dictionary
  94         Table
  95         (
  96             const word& entryName,
  97             const dictionary& dict
  98         );
  99
 100
 101     //- Destructor
 102
 103         ~Table();
 104
 105
 106     // Member Functions
 107
 108         //- Return Table value
 109         Type value(const scalar x) const;
 110
 111         //- Integrate between two (scalar) values
 112         Type integrate(const scalar x1, const scalar x2) const;
 113 };
 114
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 } // End namespace Foam
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 #ifdef NoRepository
 123 #   include "Table.C"
 124 #endif
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 127
 128 #endif
 129
 130 // ************************************************************************* //