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

lineEdge.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::lineEdge
00026 
00027 Description
00028     A straight edge between the start point and the end point.
00029 
00030 SourceFiles
00031     lineEdge.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef lineEdge_H
00036 #define lineEdge_H
00037 
00038 #include "curvedEdge.H"
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                           Class lineEdge Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 
00050 class lineEdge
00051 :
00052     public curvedEdge
00053 {
00054     // Private Member Functions
00055 
00056         //- Disallow default bitwise copy construct
00057         lineEdge(const lineEdge&);
00058 
00059         //- Disallow default bitwise assignment
00060         void operator=(const lineEdge&);
00061 
00062 public:
00063 
00064     //- Runtime type information
00065     TypeName("line");
00066 
00067     // Constructors
00068 
00069         //- Construct from components
00070         lineEdge(const pointField&, const label start, const label end);
00071 
00072         //- Construct from Istream with a pointField
00073         lineEdge(const pointField&, Istream&);
00074 
00075 
00076         //- Destructor
00077         virtual ~lineEdge();
00078 
00079 
00080     // Member Functions
00081 
00082         //- Return the point position corresponding to the curve parameter
00083         //  0 <= lambda <= 1
00084         point position(const scalar) const;
00085 
00086         //- Return the length of the curve
00087         scalar length() const;
00088 };
00089 
00090 
00091 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00092 
00093 } // End namespace Foam
00094 
00095 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00096 
00097 #endif
00098 
00099 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines