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