src/OpenFOAM/meshes/primitiveShapes/pyramid/pyramid.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::pyramid
  27
  28 Description
  29     A geometric pyramid primitive with a base of 'n' sides:
  30     i.e. a parametric pyramid. A pyramid is constructed from
  31     a base polygon and an apex point.
  32
  33 SourceFiles
  34     pyramidI.H
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef pyramid_H
  39 #define pyramid_H
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 // Forward declaration of friend functions and operators
  47
  48 template<class Point, class PointRef, class polygonRef>
  49 class pyramid;
  50
  51 template<class Point, class PointRef, class polygonRef>
  52 inline Istream& operator>>
  53 (
  54     Istream&,
  55     pyramid<Point, PointRef, polygonRef>&
  56 );
  57
  58 template<class Point, class PointRef, class polygonRef>
  59 inline Ostream& operator<<
  60 (
  61     Ostream&,
  62     const pyramid<Point, PointRef, polygonRef>&
  63 );
  64
  65
  66 /*---------------------------------------------------------------------------*\
  67                            Class pyramid Declaration
  68 \*---------------------------------------------------------------------------*/
  69
  70 template<class Point, class PointRef, class polygonRef>
  71 class pyramid
  72 {
  73     // Private data
  74
  75         polygonRef base_;
  76         PointRef apex_;
  77
  78
  79 public:
  80
  81     // Constructors
  82
  83         //- Construct from base polygon and apex point
  84         inline pyramid(polygonRef base, const Point& apex);
  85
  86         //- Construct from Istream
  87         inline pyramid(Istream&);
  88
  89
  90     // Member functions
  91
  92         // Access
  93
  94             //- Return apex point
  95             inline const Point& apex() const;
  96
  97             //- Return base polygon
  98             inline polygonRef base() const;
  99
 100
 101         // Properties
 102
 103             //- Return centre (centroid)
 104             inline Point centre(const pointField& points) const;
 105
 106             //- Return height vector
 107             inline vector height(const pointField& points) const;
 108
 109             //- Return scalar magnitude - returns volume of pyramid
 110             inline scalar mag(const pointField& points) const;
 111
 112
 113     // IOstream operators
 114
 115         friend Istream& operator>> <Point, PointRef, polygonRef>
 116         (
 117             Istream&,
 118             pyramid&
 119         );
 120
 121         friend Ostream& operator<< <Point, PointRef, polygonRef>
 122         (
 123             Ostream&,
 124             const pyramid&
 125         );
 126 };
 127
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 } // End namespace Foam
 132
 133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 134
 135 #include "pyramidI.H"
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 138
 139 #endif
 140
 141 // ************************************************************************* //