FreeFOAM The Cross-Platform CFD Toolkit
extrudeModel.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::extrudeModel
26 
27 Description
28  Top level extrusion model class
29 
30 SourceFiles
31  extrudeModel.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef extrudeModel_H
36 #define extrudeModel_H
37 
38 #include <OpenFOAM/dictionary.H>
39 #include <OpenFOAM/point.H>
40 #include <OpenFOAM/autoPtr.H>
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class extrudeModel Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 {
54 protected:
55 
56  // Protected data
57 
58  const label nLayers_;
59 
60  const dictionary& dict_;
61 
63 
64 
65  // Private Member Functions
66 
67  //- Disallow default bitwise copy construct
68  extrudeModel(const extrudeModel&);
69 
70  //- Disallow default bitwise assignment
71  void operator=(const extrudeModel&);
72 
73 
74 public:
75 
76  //- Runtime type information
77  TypeName("extrudeModel");
78 
79  //- Declare runtime constructor selection table
80 
82  (
83  autoPtr,
85  dictionary,
86  (
87  const dictionary& dict
88  ),
89  (dict)
90  );
91 
92 
93  // Constructors
94 
95  //- Construct from dictionary
96  extrudeModel(const word& modelType, const dictionary&);
97 
98 
99  // Selectors
100 
101  //- Select null constructed
102  static autoPtr<extrudeModel> New(const dictionary&);
103 
104 
105  //- Destructor
106  virtual ~extrudeModel();
107 
108 
109  // Member Functions
110 
111  // Access
112 
113  label nLayers() const;
114 
115 
116  // Member Operators
117 
118  virtual point operator()
119  (
120  const point& surfacePoint,
121  const vector& surfaceNormal,
122  const label layer
123  ) const = 0;
124 };
125 
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 } // End namespace Foam
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************ vim: set sw=4 sts=4 et: ************************ //