Initial commit for version 2.0.x patch release
[OpenFOAM-2.0.x.git] / src / lagrangian / dieselSpray / spraySubModels / collisionModel / ORourke / ORourkeCollisionModel.H
blob25941587d8833622e38c2eca1030467de5be1933
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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.
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.
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/>.
24 Class
25     Foam::ORourkeCollisionModel
27 Description
28     Collision model by P.J. O'Rourke.
30     Implemented as described in the KIVA manual
32 \*---------------------------------------------------------------------------*/
34 #ifndef ORourkeCollisionModel_H
35 #define ORourkeCollisionModel_H
37 #include "collisionModel.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 /*---------------------------------------------------------------------------*\
46                    Class ORourkeCollisionModel Declaration
47 \*---------------------------------------------------------------------------*/
49 class ORourkeCollisionModel
51     public collisionModel
54 private:
56     // Private data
58         // Reference to the cell volumes
59         const scalarField& vols_;
61         dictionary coeffsDict_;
62         Switch coalescence_;
65 public:
67     //- Runtime type information
68     TypeName("ORourke");
71     // Constructors
73         //- Construct from components
74         ORourkeCollisionModel
75         (
76             const dictionary& dict,
77             spray& sm,
78             cachedRandom& rndGen
79         );
82     //- Destructor
83     virtual ~ORourkeCollisionModel();
86     // Member Functions
88         void collideParcels(const scalar dt) const;
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 } // End namespace Foam
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 #endif
100 // ************************************************************************* //