FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

extrudeModel.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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::extrudeModel
00026 
00027 Description
00028     Top level extrusion model class
00029 
00030 SourceFiles
00031     extrudeModel.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef extrudeModel_H
00036 #define extrudeModel_H
00037 
00038 #include <OpenFOAM/dictionary.H>
00039 #include <OpenFOAM/point.H>
00040 #include <OpenFOAM/autoPtr.H>
00041 #include <OpenFOAM/runTimeSelectionTables.H>
00042 
00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00044 
00045 namespace Foam
00046 {
00047 
00048 /*---------------------------------------------------------------------------*\
00049                         Class extrudeModel Declaration
00050 \*---------------------------------------------------------------------------*/
00051 
00052 class extrudeModel
00053 {
00054 protected:
00055 
00056     // Protected data
00057 
00058         const label nLayers_;
00059 
00060         const dictionary& dict_;
00061 
00062         const dictionary& coeffDict_;
00063 
00064 
00065     // Private Member Functions
00066 
00067         //- Disallow default bitwise copy construct
00068         extrudeModel(const extrudeModel&);
00069 
00070         //- Disallow default bitwise assignment
00071         void operator=(const extrudeModel&);
00072 
00073 
00074 public:
00075 
00076     //- Runtime type information
00077     TypeName("extrudeModel");
00078 
00079     //- Declare runtime constructor selection table
00080 
00081         declareRunTimeSelectionTable
00082         (
00083             autoPtr,
00084             extrudeModel,
00085             dictionary,
00086             (
00087                 const dictionary& dict
00088             ),
00089             (dict)
00090         );
00091 
00092 
00093     // Constructors
00094 
00095         //- Construct from dictionary
00096         extrudeModel(const word& modelType, const dictionary&);
00097 
00098 
00099     // Selectors
00100 
00101         //- Select null constructed
00102         static autoPtr<extrudeModel> New(const dictionary&);
00103 
00104 
00105     //- Destructor
00106     virtual ~extrudeModel();
00107 
00108 
00109     // Member Functions
00110 
00111         // Access
00112 
00113             label nLayers() const;
00114 
00115 
00116     // Member Operators
00117 
00118         virtual point operator()
00119         (
00120             const point& surfacePoint,
00121             const vector& surfaceNormal,
00122             const label layer
00123         ) const = 0;
00124 };
00125 
00126 
00127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00128 
00129 } // End namespace Foam
00130 
00131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00132 
00133 #endif
00134 
00135 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines