OpenFOAM logo
Open Source CFD Toolkit

coord2D.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-2005 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 the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     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, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     coord2D
00027 
00028 Description
00029     Coordinate in 2D.
00030 
00031 SourceFiles
00032     coord2DI.H
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef coord2D_H
00037 #define coord2D_H
00038 
00039 #include "label.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 class Gstream;
00047 
00048 
00049 /*---------------------------------------------------------------------------*\
00050                            Class coord2D Declaration
00051 \*---------------------------------------------------------------------------*/
00052 
00053 class coord2D
00054 {
00055     // Private data
00056 
00057     label X;
00058     label Y;
00059 
00060 public:
00061 
00062     // Constructors
00063 
00064         //- Construct from components
00065         coord2D(const label, const label);
00066 
00067         //- Construct as copy
00068         coord2D(const coord2D&);
00069 
00070 
00071     // Destructor
00072 
00073         ~coord2D();
00074 
00075 
00076     // Member Functions
00077 
00078         // Access
00079 
00080             label x() const;
00081             label y() const;
00082 
00083 
00084     // Member Operators
00085 
00086         void operator=(const coord2D&);
00087 
00088 
00089     // Friend Operators
00090 
00091         //- addition + subtraction
00092         inline friend coord2D operator+(const coord2D&, const coord2D&);
00093         inline friend coord2D operator-(const coord2D&, const coord2D&);
00094 
00095         //- modulo division
00096         inline friend coord2D operator/(const coord2D&, const int&);
00097 };
00098 
00099 
00100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00101 
00102 } // End namespace Foam
00103 
00104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00105 
00106 // include inline implementaions
00107 
00108 #include "coord2DI.H"
00109 
00110 
00111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00112 
00113 #endif
00114 
00115 // ************************************************************************* //
For further information go to www.openfoam.org