src/lagrangian/basic/polyMeshInfo/polyMeshInfo.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::polyMeshInfo
  27
  28 Description
  29
  30
  31 SourceFiles
  32     polyMeshInfo.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef polyMeshInfo_H
  37 #define polyMeshInfo_H
  38
  39 #include "polyMesh.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                         Class polyMeshInfo Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class polyMeshInfo
  51 {
  52
  53     // Private data
  54
  55         //- Reference to the mesh
  56         const polyMesh& mesh_;
  57
  58         //- Vector of valid directions in mesh
  59         //  defined according to the presence of empty patches
  60         mutable Vector<label> directions_;
  61
  62         //- Number of number of valid geoemtric dimensions in the mesh
  63         label nGeometricD_;
  64
  65         //- Number of number of valid solution dimensions in the mesh
  66         //  For wedge cases this includes the circumferential direction
  67         //  in case of swirl
  68         label nSolutionD_;
  69
  70         //- Plane normal to the wedge patches, or between empty patches
  71         // for slab 2-D cases
  72         vector centreNormal_;
  73
  74         //- Empty/unused component for 2-D cases
  75         label emptyComponent_;
  76
  77         //- Geometric centre point
  78         vector centrePoint_;
  79
  80         //- Number of empty patches
  81         label nEmpty_;
  82
  83         //- Number of wedge patches
  84         label nWedge_;
  85
  86         //- Axis of wedge
  87         vector wedgeAxis_;
  88
  89         //- Angle of wedge
  90         scalar wedgeAngle_;
  91
  92
  93     // Private member functions
  94
  95         //- Set the value of the mesh centre point
  96         void setCentrePoint();
  97
  98         //- Determine wedge information
  99         void queryWedge();
 100
 101         //- Determine mesh directions
 102         void queryDirections();
 103
 104
 105 public:
 106
 107     //- Runtime type information
 108     TypeName("polyMeshInfo");
 109
 110     // Constructors
 111
 112         //- Construct from components
 113         polyMeshInfo
 114         (
 115             const polyMesh& mesh
 116         );
 117
 118
 119     // Destructors
 120
 121         virtual ~polyMeshInfo();
 122
 123
 124     // Member functions
 125
 126         //- Access
 127
 128             //- Return the number of valid geoemtric dimensions in the mesh
 129             label nGeometricD() const;
 130
 131             //- Return the number of valid solution dimensions in the mesh
 132             label nSolutionD() const;
 133
 134             //- Flag to indicate whether case is a 2-D wedge
 135             bool caseIs2dWedge() const;
 136
 137             //- Flag to indicate whether case is a 2-D slab
 138             bool caseIs2dSlab() const;
 139
 140             //- Flag to indicate whether case is 2-D
 141             bool caseIs2d() const;
 142
 143             //- Flag to indicate whether case is 3-D
 144             bool caseIs3d() const;
 145
 146             //- Return axis of wedge
 147             vector wedgeAxis() const;
 148
 149             //- Return angle of wedge
 150             scalar wedgeAngle() const;
 151
 152             //- Return the centre normal
 153             vector centreNormal() const;
 154
 155             //- Return empty component
 156             label emptyComponent() const;
 157
 158             //- Return centre point
 159             vector centrePoint() const;
 160
 161             //- Set the empty component direction based on normal vector dir
 162             void setEmptyComponent(const vector& dir);
 163
 164 };
 165
 166
 167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 168
 169 } // End namespace Foam
 170
 171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 172
 173 #endif
 174
 175 // ************************************************************************* //
 176