FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

polyLineEdge.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::polyLineEdge
00026 
00027 Description
00028     A curvedEdge defined in terms of a series of straight line segments.
00029 
00030 SourceFiles
00031     polyLineEdge.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef polyLineEdge_H
00036 #define polyLineEdge_H
00037 
00038 #include "curvedEdge.H"
00039 #include "polyLine.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                         Class polyLineEdge Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class polyLineEdge
00051 :
00052     public curvedEdge,
00053     public polyLine
00054 {
00055     // Private Member Functions
00056 
00057         //- Disallow default bitwise copy construct
00058         polyLineEdge(const polyLineEdge&);
00059 
00060         //- Disallow default bitwise assignment
00061         void operator=(const polyLineEdge&);
00062 
00063 
00064 public:
00065 
00066     // Static data members
00067     TypeName("polyLine");
00068 
00069 
00070     // Constructors
00071 
00072         //- Construct from components
00073         polyLineEdge
00074         (
00075             const pointField&,
00076             const label start,
00077             const label end,
00078             const pointField& otherPoints
00079         );
00080 
00081         //- Construct from Istream
00082         polyLineEdge(const pointField&, Istream&);
00083 
00084 
00085         //- Destructor
00086         virtual ~polyLineEdge();
00087 
00088 
00089     // Member Functions
00090 
00091         //- Return the point position corresponding to the curve parameter
00092         //  0 <= lambda <= 1
00093         point position(const scalar lambda) const;
00094 
00095         //- Return the length of the curve
00096         scalar length() const;
00097 };
00098 
00099 
00100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00101 
00102 } // End namespace Foam
00103 
00104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00105 
00106 #endif
00107 
00108 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines