src/lagrangian/dieselSpray/spraySubModels/collisionModel/collisionModel/collisionModel.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::collisionModel
  27
  28 Description
  29     Base case for selecting a collision model
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef collisionModel_H
  34 #define collisionModel_H
  35
  36 #include "IOdictionary.H"
  37 #include "spray.H"
  38 #include "Random.H"
  39 #include "Switch.H"
  40 #include "autoPtr.H"
  41 #include "runTimeSelectionTables.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class collisionModel Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class collisionModel
  53 {
  54
  55 protected:
  56
  57     // Protected data
  58         const dictionary& dict_;
  59         spray& spray_;
  60         Random& rndGen_;
  61
  62         //dictionary coeffsDict_;
  63
  64
  65 public:
  66
  67     //- Runtime type information
  68     TypeName("collisionModel");
  69
  70     // Declare runtime constructor selection table
  71
  72         declareRunTimeSelectionTable
  73         (
  74             autoPtr,
  75             collisionModel,
  76             dictionary,
  77             (
  78                 const dictionary& dict,
  79                 spray& sm,
  80                 Random& rndGen
  81             ),
  82             (dict, sm, rndGen)
  83         );
  84
  85
  86     // Constructors
  87
  88         //- Construct from components
  89         collisionModel
  90         (
  91             const dictionary& dict,
  92             spray& sm,
  93             Random& rndGen
  94         );
  95
  96
  97     // Destructor
  98
  99         virtual ~collisionModel();
 100
 101
 102     // Selector
 103
 104         static autoPtr<collisionModel> New
 105         (
 106             const dictionary& dict,
 107             spray& sm,
 108             Random& rndGen
 109         );
 110
 111
 112     // Member Functions
 113
 114         virtual void collideParcels(const scalar dt) const = 0;
 115 };
 116
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 } // End namespace Foam
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 #endif
 125
 126 // ************************************************************************* //