OpenFOAM logo
Open Source CFD Toolkit

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