FreeFOAM The Cross-Platform CFD Toolkit
wallModel.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::wallModel
26 
27 Description
28  A wall interaction model
29 
30 SourceFiles
31  wallModelI.H
32  wallModel.C
33  wallModelIO.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef wallModel_H
38 #define wallModel_H
39 
40 #include <dieselSpray/spray.H>
41 #include <OpenFOAM/IOdictionary.H>
42 #include <finiteVolume/fvCFD.H>
43 #include <OpenFOAM/autoPtr.H>
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class wallModel Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class wallModel
56 {
57 
58 protected:
59 
60  // Protected data
61 
62  const dictionary& dict_;
63  const fvMesh& mesh_;
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("wallModel");
71 
72  // Declare runtime constructor selection table
73 
75  (
76  autoPtr,
77  wallModel,
78  dictionary,
79  (
80  const dictionary& dict,
81  const volVectorField& U,
82  spray& sm
83  ),
84  (dict, U, sm)
85  );
86 
87 
88  // Constructors
89 
90  //- Construct from components
91  wallModel
92  (
93  const dictionary& dict,
94  const volVectorField& U,
95  spray& sm
96  );
97 
98 
99  // Destructor
100 
101  virtual ~wallModel();
102 
103 
104  // Selector
105 
106  static autoPtr<wallModel> New
107  (
108  const dictionary& dict,
109  const volVectorField& U,
110  spray& sm
111  );
112 
113 
114  // Member Functions
115 
116  //- Return true if parcel is to be kept, false if it is to be removed
117  virtual bool wallTreatment
118  (
119  parcel& parcel,
120  const label facei
121  ) const = 0;
122 
123 };
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace Foam
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************ vim: set sw=4 sts=4 et: ************************ //