applications/utilities/mesh/generation/blockMesh/blockDescriptor.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::blockDescriptor
  27
  28 Description
  29     block descriptor. Takes the description of the block and the list
  30     of curved edges and creates a list of points on edges together
  31     with the weighting factors
  32
  33 SourceFiles
  34     blockDescriptor.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef blockDescriptor_H
  39 #define blockDescriptor_H
  40
  41 #include "scalar.H"
  42 #include "label.H"
  43 #include "point.H"
  44 #include "cellShape.H"
  45 #include "scalarList.H"
  46 #include "curvedEdgeList.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 class Istream;
  54 class Ostream;
  55
  56 /*---------------------------------------------------------------------------*\
  57                            Class blockDescriptor Declaration
  58 \*---------------------------------------------------------------------------*/
  59
  60 class blockDescriptor
  61 {
  62     // Private data
  63
  64         //- Block mesh points
  65         const pointField& blockMeshPoints_;
  66
  67         //- block shape
  68         cellShape blockShape_;
  69
  70         // reference to a list of curved edges
  71         const curvedEdgeList& curvedEdges_;
  72
  73         // block edge points
  74         List<List<point> > edgePoints_;
  75
  76         //- block edge weighting factors
  77         scalarListList edgeWeights_;
  78
  79         //- number of point in each direction
  80         Vector<label> n_;
  81
  82         //- expansion ratios in all directions
  83         scalarList expand_;
  84
  85         //- name of the zone (empty string if none)
  86         word zoneName_;
  87
  88     // Private member functions
  89
  90         void makeBlockEdges();
  91
  92         void setEdge(label edge, label start, label end, label dim);
  93
  94
  95 public:
  96
  97     // Constructors
  98
  99         //- Construct from components. Optional cellSet/zone name.
 100         blockDescriptor
 101         (
 102             const cellShape&,
 103             const pointField& blockMeshPoints,
 104             const curvedEdgeList& edges,
 105             const Vector<label>& n,
 106             const scalarList& expand,
 107             const word& zoneName = ""
 108         );
 109
 110         //- Construct from Istream
 111         blockDescriptor
 112         (
 113             const pointField& blockMeshPoints,
 114             const curvedEdgeList& edges,
 115             Istream& is
 116         );
 117
 118         //- Clone
 119         autoPtr<blockDescriptor> clone() const
 120         {
 121             notImplemented("blockDescriptor::clone()");
 122             return autoPtr<blockDescriptor>(NULL);
 123         }
 124
 125
 126     // Member Functions
 127
 128         // Access
 129
 130         const pointField& points() const;
 131
 132         const cellShape& blockShape() const;
 133
 134         const List<List<point> >& blockEdgePoints() const;
 135
 136         const scalarListList& blockEdgeWeights() const;
 137
 138         const Vector<label>& n() const;
 139
 140         const word& zoneName() const;
 141
 142     // Member Operators
 143
 144         void operator=(const blockDescriptor&);
 145
 146
 147     // IOstream Operators
 148
 149         friend Ostream& operator<<(Ostream&, const blockDescriptor&);
 150 };
 151
 152
 153 inline Istream& operator>>(Istream& is, blockDescriptor*)
 154 {
 155     notImplemented("Istream& operator>>(Istream& is, blockDescriptor*)");
 156     return is;
 157 }
 158
 159
 160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 161
 162 } // End namespace Foam
 163
 164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 165
 166 #endif
 167
 168 // ************************************************************************* //