OpenFOAM logo
Open Source CFD Toolkit

injector.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     injector
00027 
00028 Description
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef injector_H
00033 #define injector_H
00034 
00035 #include "vector.H"
00036 #include "List.H"
00037 #include "dictionary.H"
00038 #include "autoPtr.H"
00039 #include "runTimeSelectionTables.H"
00040 #include "Time.H"
00041 #include "injectorType.H"
00042 
00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00044 
00045 namespace Foam
00046 {
00047 
00048 /*---------------------------------------------------------------------------*\
00049                            Class injector Declaration
00050 \*---------------------------------------------------------------------------*/
00051 
00052 class injector
00053 {
00054     // Private data
00055 
00056         dictionary injectorDict_;
00057 
00058         autoPtr<injectorType> properties_;
00059 
00060 
00061 public:
00062 
00063     // Constructors
00064     
00065         //- Constructor from Istream
00066         injector(const Time& t, Istream& is);
00067 
00068         //- Return clone
00069         inline autoPtr<injector> clone() const;
00070 
00071         //- Return a pointer to a new injector created on freestore
00072         //  from Istream
00073         class iNew
00074         {
00075             const Time& time_;
00076 
00077         public:
00078 
00079             iNew(const Time& t)
00080             :
00081                 time_(t)
00082             {}
00083 
00084             autoPtr<injector> operator()(Istream& is) const
00085             {
00086                 return autoPtr<injector>(new injector(time_, is));
00087             }
00088         };
00089 
00090 
00091     // Member Functions
00092 
00093         inline autoPtr<injectorType>& properties();
00094         inline const autoPtr<injectorType>& properties() const;
00095 
00096 
00097     // Ostream Operator
00098 
00099         friend Ostream& operator<<(Ostream&, const injector&);
00100 };
00101 
00102 
00103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00104 
00105 } // End namespace Foam
00106 
00107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00108 
00109 #include "injectorI.H"
00110 
00111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00112 
00113 #endif
00114 
00115 // ************************************************************************* //
For further information go to www.openfoam.org