Initial commit for version 2.0.x patch release
[OpenFOAM-2.0.x.git] / applications / utilities / mesh / generation / extrude / extrudeModel / linearDirection / linearDirection.H
blob7e0547a08abcfe59be0ed411631423c6993febe4
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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.
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.
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/>.
24 Class
25     Foam::extrudeModels::linearDirection
27 Description
28     Extrudes by transforming points in a specified direction by a given distance
30 \*---------------------------------------------------------------------------*/
32 #ifndef linearDirection_H
33 #define linearDirection_H
35 #include "point.H"
36 #include "extrudeModel.H"
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 namespace Foam
42 namespace extrudeModels
45 /*---------------------------------------------------------------------------*\
46                     Class linearDirection Declaration
47 \*---------------------------------------------------------------------------*/
49 class linearDirection
51     public extrudeModel
53     // Private data
55         //- Extrude direction
56         vector direction_;
58         //- layer thickness
59         scalar thickness_;
62 public:
64     //- Runtime type information
65     TypeName("linearDirection");
67     // Constructors
69         //- Construct from dictionary
70         linearDirection(const dictionary& dict);
73     //- Destructor
74     virtual ~linearDirection();
77     // Member Operators
79         point operator()
80         (
81             const point& surfacePoint,
82             const vector& surfaceNormal,
83             const label layer
84         ) const;
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 } // End namespace extrudeModels
91 } // End namespace Foam
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 #endif
97 // ************************************************************************* //