OpenFOAM logo
Open Source CFD Toolkit

dispersionModel.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     dispersionModel
00027 
00028 Description
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef dispersionModel_H
00033 #define dispersionModel_H
00034 
00035 #include "IOdictionary.H"
00036 #include "spray.H"
00037 #include "autoPtr.H"
00038 #include "runTimeSelectionTables.H"
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                            Class dispersionModel Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 class dispersionModel
00050 {
00051 
00052 protected:
00053 
00054     // Protected data
00055 
00056         const dictionary& dict_;
00057         spray& spray_;
00058 
00059 
00060 public:
00061 
00062     //- Runtime type information
00063     TypeName("dispersionModel");
00064 
00065 
00066     // Declare runtime constructor selection table
00067 
00068         declareRunTimeSelectionTable
00069         (
00070             autoPtr,
00071             dispersionModel,
00072             dictionary,
00073             (
00074                 const dictionary& dict,
00075                 spray& sm
00076             ),
00077             (dict, sm)
00078         );
00079 
00080 
00081     // Constructors
00082 
00083         //- Construct from components
00084         dispersionModel
00085         (
00086             const dictionary& dict,
00087             spray& sm
00088         );
00089 
00090 
00091     // Destructor
00092 
00093         virtual ~dispersionModel();
00094 
00095 
00096     // Selector
00097 
00098         static autoPtr<dispersionModel> New
00099         (
00100             const dictionary& dict,
00101             spray& sm
00102         );
00103 
00104 
00105     // Member Functions
00106 
00107         virtual void disperseParcels() const = 0;
00108 };
00109 
00110 
00111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00112 
00113 } // End namespace Foam
00114 
00115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00116 
00117 #endif
00118 
00119 // ************************************************************************* //
For further information go to www.openfoam.org