src/OpenFOAM/fields/GeometricFields/geometricZeroField/geometricZeroField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::geometricZeroField
  26
  27 Description
  28     A class representing the concept of a GeometricField of 1 used to avoid
  29     unnecessary manipulations for objects which are known to be zero at
  30     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 geometricZeroField_H
  38 #define geometricZeroField_H
  39
  40 #include "zeroFieldField.H"
  41 #include "scalar.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                       Class geometricZeroField Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class geometricZeroField
  53 :
  54     public zero
  55 {
  56
  57 public:
  58
  59     // Constructors
  60
  61         //- Construct null
  62         geometricZeroField()
  63         {}
  64
  65
  66     // Member Operators
  67
  68         inline scalar operator[](const label) const;
  69
  70         inline zeroField field() const;
  71
  72         inline zeroField oldTime() const;
  73
  74         inline zeroFieldField boundaryField() const;
  75 };
  76
  77
  78 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  79
  80 } // End namespace Foam
  81
  82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  83
  84 #   include "geometricZeroFieldI.H"
  85
  86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  87
  88 #endif
  89
  90 // ************************************************************************* //