applications/utilities/mesh/generation/blockMesh/block.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::block
  27
  28 Description
  29     creates a single block of cells from point coordinates,
  30     numbers of cells in each direction and expansion ratio
  31
  32 SourceFiles
  33     block.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef block_H
  38 #define block_H
  39
  40 #include "pointField.H"
  41 #include "labelList.H"
  42
  43 #include "blockDescriptor.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 class Istream;
  51 class Ostream;
  52
  53 /*---------------------------------------------------------------------------*\
  54                            Class block Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class block
  58 {
  59     // Private data
  60
  61         //- block definition
  62         blockDescriptor blockDef_;
  63
  64         //- list of vertices
  65         pointField vertices_;
  66
  67         //- list of cells
  68         labelListList cells_;
  69
  70         //- boundary patches
  71         labelListListList boundaryPatches_;
  72
  73
  74     // private member functions
  75
  76         label vtxLabel(label i, label j, label k);
  77
  78         void blockPoints();
  79
  80         void blockCells();
  81
  82         void blockBoundary();
  83
  84
  85 public:
  86
  87     // Constructors
  88
  89         //- Construct from the block definition
  90         block(const blockDescriptor&);
  91
  92         //- Clone
  93         autoPtr<block> clone() const
  94         {
  95             notImplemented("block::clone()");
  96             return autoPtr<block>(NULL);
  97         }
  98
  99
 100     // Member Functions
 101
 102         // Access
 103
 104             const blockDescriptor& blockDef() const;
 105             const pointField& points() const;
 106             const labelListList& cells() const;
 107             const labelListListList& boundaryPatches() const;
 108
 109
 110     // Ostream Operator
 111
 112         friend Ostream& operator<<(Ostream&, const block&);
 113 };
 114
 115
 116 inline Istream& operator>>(Istream& is, block*)
 117 {
 118     notImplemented("Istream& operator>>(Istream& is, block*)");
 119     return is;
 120 }
 121
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 } // End namespace Foam
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 #endif
 130
 131 // ************************************************************************* //