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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::lineDivide
28 
29 Description
30  Divides a line into segments
31 
32 SourceFiles
33  lineDivide.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef lineDivide_H
38 #define lineDivide_H
39 
40 #include "pointField.H"
41 #include "scalarList.H"
42 #include "gradingDescriptors.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 class blockEdge;
50 
51 /*---------------------------------------------------------------------------*\
52  Class lineDivide Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class lineDivide
56 {
57  // Private data
58 
59  pointField points_;
60 
61  scalarList divisions_;
62 
63 public:
64 
65  // Constructors
66 
67  //- Construct from components
68  lineDivide
69  (
70  const blockEdge&,
71  const label ndiv,
72  const gradingDescriptors& gd = gradingDescriptors()
73  );
74 
75 
76  // Member Functions
77 
78  //- Return the points
79  const pointField& points() const;
80 
81  //- Return the list of lambda values
82  const scalarList& lambdaDivisions() const;
83 };
84 
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 } // End namespace Foam
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 #endif
93 
94 // ************************************************************************* //
Foam::lineDivide::points
const pointField & points() const
Return the points.
Definition: lineDivide.C:142
Foam::fac::ndiv
tmp< GeometricField< Type, faPatchField, areaMesh > > ndiv(const GeometricField< Type, faePatchField, edgeMesh > &ssf)
Definition: facNDiv.C:50
Foam::lineDivide::lineDivide
lineDivide(const blockEdge &, const label ndiv, const gradingDescriptors &gd=gradingDescriptors())
Construct from components.
Definition: lineDivide.C:46
Foam::lineDivide
Divides a line into segments.
Definition: lineDivide.H:54
Foam::gradingDescriptors
List of gradingDescriptor for the sections of a block with additional IO functionality.
Definition: gradingDescriptors.H:58
Foam::blockEdge
Define a curved edge that is parameterized for 0<lambda<1 between the start and end point.
Definition: blockEdge.H:59
scalarList.H
gradingDescriptors.H
Foam::Field< vector >
Foam::lineDivide::lambdaDivisions
const scalarList & lambdaDivisions() const
Return the list of lambda values.
Definition: lineDivide.C:148
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
pointField.H
Foam::List< scalar >