src/lagrangian/dieselSpray/injector/injector/injector.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::injector
  27
  28 Description
  29     Spray injector
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef injector_H
  34 #define injector_H
  35
  36 #include "vector.H"
  37 #include "List.H"
  38 #include "dictionary.H"
  39 #include "autoPtr.H"
  40 #include "runTimeSelectionTables.H"
  41 #include "Time.H"
  42 #include "injectorType.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class injector Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class injector
  54 {
  55     // Private data
  56
  57         dictionary injectorDict_;
  58
  59         autoPtr<injectorType> properties_;
  60
  61
  62 public:
  63
  64     // Constructors
  65
  66         //- Constructor from Istream
  67         injector(const Time& t, Istream& is);
  68
  69         //- Return clone
  70         inline autoPtr<injector> clone() const;
  71
  72         //- Return a pointer to a new injector created on freestore
  73         //  from Istream
  74         class iNew
  75         {
  76             const Time& time_;
  77
  78         public:
  79
  80             iNew(const Time& t)
  81             :
  82                 time_(t)
  83             {}
  84
  85             autoPtr<injector> operator()(Istream& is) const
  86             {
  87                 return autoPtr<injector>(new injector(time_, is));
  88             }
  89         };
  90
  91
  92     // Member Functions
  93
  94         inline autoPtr<injectorType>& properties();
  95         inline const autoPtr<injectorType>& properties() const;
  96
  97
  98     // Ostream Operator
  99
 100         friend Ostream& operator<<(Ostream&, const injector&);
 101 };
 102
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 } // End namespace Foam
 107
 108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 109
 110 #include "injectorI.H"
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 #endif
 115
 116 // ************************************************************************* //