src/lagrangian/dieselSpray/spraySubModels/wallModel/removeParcel/removeParcel.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::removeParcel
  27
  28 Description
  29     remove parcel, regardless of boundary type.
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef removeParcel_H
  34 #define removeParcel_H
  35
  36 #include "wallModel.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42
  43 /*---------------------------------------------------------------------------*\
  44                            Class removeParcel Declaration
  45 \*---------------------------------------------------------------------------*/
  46
  47 class removeParcel
  48 :
  49     public wallModel
  50 {
  51
  52 public:
  53
  54     //- Runtime type information
  55     TypeName("remove");
  56
  57
  58     // Constructors
  59
  60         //- Construct from components
  61         removeParcel
  62         (
  63             const dictionary& dict,
  64             const volVectorField& U,
  65             spray& sm
  66         );
  67
  68
  69     // Destructor
  70
  71         virtual ~removeParcel();
  72
  73
  74     // Member Functions
  75
  76         //- Return true if parcel is to be kept, and false if it is to be
  77         // removed
  78         bool wallTreatment
  79         (
  80             parcel& parcel,
  81             const label facei
  82         ) const;
  83
  84 };
  85
  86
  87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  88
  89 } // End namespace Foam
  90
  91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  92
  93 #endif
  94
  95 // ************************************************************************* //