src/OpenFOAM/fields/Fields/zeroField/zeroField.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::zeroField
  26
  27 Description
  28     A class representing the concept of a field of 0 used to avoid unnecessary
  29     manipulations for objects which are known to be zero at compile-time.
  30
  31     Used for example as the argument to a function in which certain terms are
  32     optional, see source terms in the MULES solvers.
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef zeroField_H
  37 #define zeroField_H
  38
  39 #include "zero.H"
  40 #include "scalar.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class zeroField Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class zeroField
  52 :
  53     public zero
  54 {
  55 public:
  56
  57     // Constructors
  58
  59         //- Construct null
  60         zeroField()
  61         {}
  62
  63
  64     // Member Operators
  65
  66         inline scalar operator[](const label) const;
  67
  68         inline zeroField field() const;
  69 };
  70
  71
  72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  73
  74 } // End namespace Foam
  75
  76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  77
  78 #include "zeroFieldI.H"
  79
  80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  81
  82 #endif
  83
  84 // ************************************************************************* //