OpenFOAM logo
Open Source CFD Toolkit

wallModel.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     wallModel
00027 
00028 Description
00029 
00030 SourceFiles
00031     wallModelI.H
00032     wallModel.C
00033     wallModelIO.C
00034 
00035 \*---------------------------------------------------------------------------*/
00036 
00037 #ifndef wallModel_H
00038 #define wallModel_H
00039 
00040 #include "spray.H"
00041 #include "IOdictionary.H"
00042 #include "fvCFD.H"
00043 #include "autoPtr.H"
00044 #include "runTimeSelectionTables.H"
00045 
00046 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00047 
00048 namespace Foam
00049 {
00050 
00051 /*---------------------------------------------------------------------------*\
00052                            Class wallModel Declaration
00053 \*---------------------------------------------------------------------------*/
00054 
00055 class wallModel
00056 {
00057 
00058 protected:
00059 
00060     // Protected data
00061 
00062         const dictionary& dict_;
00063         const fvMesh& mesh_;
00064         spray& spray_;
00065 
00066 
00067 public:
00068 
00069     //- Runtime type information
00070         TypeName("wallModel");
00071 
00072     // Declare runtime constructor selection table
00073 
00074         declareRunTimeSelectionTable
00075         (
00076             autoPtr,
00077             wallModel,
00078             dictionary,
00079             (
00080                 const dictionary& dict,
00081                 const volVectorField& U,
00082                 spray& sm
00083             ),
00084             (dict, U, sm)
00085         );
00086 
00087 
00088     // Constructors
00089 
00090         //- Construct from components
00091         wallModel
00092         (
00093             const dictionary& dict,
00094             const volVectorField& U,
00095             spray& sm
00096         );
00097 
00098 
00099     // Destructor
00100 
00101         virtual ~wallModel();
00102 
00103 
00104     // Selector
00105 
00106         static autoPtr<wallModel> New
00107         (
00108             const dictionary& dict,
00109             const volVectorField& U,
00110             spray& sm
00111         );
00112 
00113 
00114     // Member Functions
00115 
00116         //- Return true if parcel is to be kept, false if it is to be removed
00117         virtual bool wallTreatment
00118         (
00119             parcel& parcel,
00120             const label facei
00121         ) const = 0;
00122 
00123 };
00124 
00125 
00126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00127 
00128 } // End namespace Foam
00129 
00130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00131 
00132 #endif
00133 
00134 // ************************************************************************* //
For further information go to www.openfoam.org