src/OpenFOAM/fields/GeometricFields/geometricOneField/geometricOneField.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::GeometricField
  27
  28 Description
  29     A class representing the concept of a GeometricField of 1 used to avoid
  30     unnecessary manipulations for objects which are known to be one at
  31     compile-time.
  32
  33     Used for example as the density argument to a function written for
  34     compressible to be used for incompressible flow.
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef geometricOneField_H
  39 #define geometricOneField_H
  40
  41 #include "oneFieldField.H"
  42 #include "scalar.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                       Class geometricOneField Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class geometricOneField
  54 :
  55     public one
  56 {
  57
  58 public:
  59
  60     // Constructors
  61
  62         //- Construct null
  63         geometricOneField()
  64         {}
  65
  66
  67     // Member Operators
  68
  69         inline scalar operator[](const label) const;
  70
  71         inline oneField field() const;
  72
  73         inline oneField oldTime() const;
  74
  75         inline oneFieldField boundaryField() const;
  76 };
  77
  78
  79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  80
  81 } // End namespace Foam
  82
  83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  84
  85 #   include "geometricOneFieldI.H"
  86
  87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  88
  89 #endif
  90
  91 // ************************************************************************* //