src/OpenFOAM/fields/Fields/oneField/oneField.H

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