src/OpenFOAM/fields/FieldFields/oneFieldField/oneFieldField.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::oneFieldField
  27
  28 Description
  29     A class representing the concept of a field of oneFields used to
  30     avoid 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 oneFieldField_H
  39 #define oneFieldField_H
  40
  41 #include "oneField.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class oneField Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class oneFieldField
  53 :
  54     public one
  55 {
  56
  57 public:
  58
  59     // Constructors
  60
  61         //- Construct null
  62         oneFieldField()
  63         {}
  64
  65
  66     // Member Operators
  67
  68         inline oneField operator[](const label) const;
  69 };
  70
  71
  72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  73
  74 } // End namespace Foam
  75
  76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  77
  78 #   include "oneFieldFieldI.H"
  79
  80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  81
  82 #endif
  83
  84 // ************************************************************************* //