applications/utilities/mesh/generation/blockMesh/curvedEdges/curvedEdge.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::curvedEdge
  27
  28 Description
  29     Define a curved edge that is parameterized for 0<lambda<1
  30     between the start and end point.
  31
  32 SourceFiles
  33     curvedEdge.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef curvedEdges_H
  38 #define curvedEdges_H
  39
  40 #include "edge.H"
  41 #include "pointField.H"
  42 #include "typeInfo.H"
  43 #include "HashTable.H"
  44 #include "autoPtr.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                          Class curvedEdge Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class curvedEdge
  56 {
  57 protected:
  58
  59     // Protected data
  60
  61         const pointField& points_;
  62         const label start_;
  63         const label end_;
  64
  65     // Protected Member Functions
  66
  67         //- Return a complete point field by appending the start/end points
  68         //  to the given list
  69         static pointField appendEndPoints
  70         (
  71             const pointField&,
  72             const label start,
  73             const label end,
  74             const pointField& otherKnots
  75         );
  76
  77
  78 public:
  79
  80     //- Runtime type information
  81     TypeName("curvedEdge");
  82
  83     // Declare run-time constructor selection tables
  84
  85         declareRunTimeSelectionTable
  86         (
  87             autoPtr,
  88             curvedEdge,
  89             Istream,
  90             (
  91                 const pointField& points,
  92                 Istream& is
  93             ),
  94             (points, is)
  95         );
  96
  97
  98     // Constructors
  99
 100         //- Construct from components
 101         curvedEdge
 102         (
 103             const pointField& points,
 104             const label start,
 105             const label end
 106         );
 107
 108         //- Construct from Istream setting pointsList
 109         curvedEdge(const pointField&, Istream&);
 110
 111         //- Copy construct
 112         curvedEdge(const curvedEdge&);
 113
 114         //- Clone function
 115         virtual autoPtr<curvedEdge> clone() const;
 116
 117         //- New function which constructs and returns pointer to a curvedEdge
 118         static autoPtr<curvedEdge> New(const pointField&, Istream&);
 119
 120
 121     // Destructor
 122
 123         virtual ~curvedEdge(){}
 124
 125
 126     // Member Functions
 127
 128         //- Return label of start point
 129         inline label start() const;
 130
 131         //- Return label of end point
 132         inline label end() const;
 133
 134         //- Compare the given start and end points with this curve
 135         //  -  0: different
 136         //  - +1: identical
 137         //  - -1: same edge, but different orientation
 138         inline int compare(const curvedEdge&) const;
 139
 140         //- Compare the given start and end points with this curve
 141         //  -  0: different
 142         //  - +1: identical
 143         //  - -1: same edge, but different orientation
 144         inline int compare(const edge&) const;
 145
 146         //- Compare the given start and end points with this curve
 147         //  -  0: different
 148         //  - +1: identical
 149         //  - -1: same edge, but different orientation
 150         inline int compare(const label start, const label end) const;
 151
 152         //- Return the point position corresponding to the curve parameter
 153         //  0 <= lambda <= 1
 154         virtual point position(const scalar) const = 0;
 155
 156         //- Return the length of the curve
 157         virtual scalar length() const = 0;
 158
 159
 160     // Member operators
 161
 162         void operator=(const curvedEdge&);
 163
 164     // Ostream operator
 165
 166         friend Ostream& operator<<(Ostream&, const curvedEdge&);
 167 };
 168
 169
 170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 171
 172 } // End namespace Foam
 173
 174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 175
 176 #include "curvedEdgeI.H"
 177
 178 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 179
 180 #endif
 181
 182 // ************************************************************************* //