FreeFOAM The Cross-Platform CFD Toolkit
removeParcel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::removeParcel
26 
27 Description
28  remove parcel, regardless of boundary type.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef removeParcel_H
33 #define removeParcel_H
34 
35 #include <dieselSpray/wallModel.H>
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 
42 /*---------------------------------------------------------------------------*\
43  Class removeParcel Declaration
44 \*---------------------------------------------------------------------------*/
45 
47 :
48  public wallModel
49 {
50 
51 public:
52 
53  //- Runtime type information
54  TypeName("remove");
55 
56 
57  // Constructors
58 
59  //- Construct from components
61  (
62  const dictionary& dict,
63  const volVectorField& U,
64  spray& sm
65  );
66 
67 
68  // Destructor
69 
70  virtual ~removeParcel();
71 
72 
73  // Member Functions
74 
75  //- Return true if parcel is to be kept, and false if it is to be
76  // removed
77  bool wallTreatment
78  (
79  parcel& parcel,
80  const label facei
81  ) const;
82 
83 };
84 
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 } // End namespace Foam
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 #endif
93 
94 // ************************ vim: set sw=4 sts=4 et: ************************ //