FreeFOAM The Cross-Platform CFD Toolkit
lineDivide.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::lineDivide
26 
27 Description
28  Divides a line into segments
29 
30 SourceFiles
31  lineDivide.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef lineDivide_H
36 #define lineDivide_H
37 
38 #include <OpenFOAM/pointField.H>
39 #include <OpenFOAM/scalarList.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 class curvedEdge;
47 
48 /*---------------------------------------------------------------------------*\
49  Class lineDivide Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 {
54  // Private data
55 
56  pointField points_;
57 
58  scalarList divisions_;
59 
60 public:
61 
62  // Constructors
63 
64  //- Construct from components with discretization and expansion ratio
66  (
67  const curvedEdge&,
68  const label ndiv,
69  const scalar xratio = 1.0
70  );
71 
72 
73  // Member Functions
74 
75  //- Return the points
76  const pointField& points() const;
77 
78  //- Return the list of lambda values
79  const scalarList& lambdaDivisions() const;
80 };
81 
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 } // End namespace Foam
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 #endif
90 
91 // ************************ vim: set sw=4 sts=4 et: ************************ //