lineDivide.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
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 "pointField.H"
39 #include "scalarList.H"
40 #include "gradingDescriptors.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 class blockEdge;
48 
49 /*---------------------------------------------------------------------------*\
50  Class lineDivide Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class lineDivide
54 {
55  // Private data
56 
57  pointField points_;
58 
59  scalarList divisions_;
60 
61 public:
62 
63  // Constructors
64 
65  //- Construct from components
67  (
68  const blockEdge&,
69  const label ndiv,
71  );
72 
73 
74  // Member Functions
75 
76  //- Return the points
77  const pointField& points() const;
78 
79  //- Return the list of lambda values
80  const scalarList& lambdaDivisions() const;
81 };
82 
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 } // End namespace Foam
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 #endif
91 
92 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
const scalarList & lambdaDivisions() const
Return the list of lambda values.
Definition: lineDivide.C:146
lineDivide(const blockEdge &, const label ndiv, const gradingDescriptors &gd=gradingDescriptors())
Construct from components.
Definition: lineDivide.C:44
const pointField & points() const
Return the points.
Definition: lineDivide.C:140
Define a curved edge that is parameterized for 0<lambda<1 between the start and end point...
Definition: blockEdge.H:56
List of gradingDescriptor for the sections of a block with additional IO functionality.
Divides a line into segments.
Definition: lineDivide.H:52
Namespace for OpenFOAM.