applications/utilities/postProcessing/miscellaneous/postChannel/channelIndex.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::channelIndex
  27
  28 Description
  29     does indexing for a standard (Christer-style) channel.
  30 Assumes that the blocks are aranged in the y direction.
  31
  32 SourceFiles
  33     channelIndex.C
  34     channelIndexIO.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef channelIndex_H
  39 #define channelIndex_H
  40
  41 #include "fvCFD.H"
  42
  43
  44 /*---------------------------------------------------------------------------*\
  45                            Class channelIndex Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 class channelIndex
  49 {
  50     // Private data
  51
  52         IOdictionary indexingDict_;
  53
  54         const label nx_;
  55         const labelList ny_;
  56         const label nz_;
  57         const bool symmetric_;
  58
  59         labelList cumNy_;
  60         label nLayers_;
  61
  62
  63     // Private Member Functions
  64
  65         //- Disallow default bitwise copy construct and assignment
  66         channelIndex(const channelIndex&);
  67         void operator=(const channelIndex&);
  68
  69
  70 public:
  71
  72     // Constructors
  73
  74         channelIndex(const fvMesh& m);
  75
  76
  77     // Destructor
  78
  79         ~channelIndex();
  80
  81
  82     // Member Functions
  83
  84         // Access
  85
  86             //- return number of layers
  87             label nLayers() const
  88             {
  89                 return nLayers_;
  90             }
  91
  92             //- number of cells in X direction
  93             label nx() const
  94             {
  95                 return nx_;
  96             }
  97
  98             //- number of cells in Z direction
  99             label nz() const
 100             {
 101                 return nz_;
 102             }
 103
 104             //- collapse a field to a line
 105             scalarField collapse
 106             (
 107                 const volScalarField& vsf,
 108                 const bool asymmetric=false
 109             ) const;
 110
 111             //- return the field of Y locations from the cell centres
 112             scalarField y
 113             (
 114                 const volVectorField& cellCentres
 115             ) const;
 116
 117
 118     // Member Operators
 119
 120         label operator()(const label, const label, const label) const;
 121 };
 122
 123
 124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 125
 126 #endif
 127
 128 // ************************************************************************* //