applications/utilities/postProcessing/dataConversion/foamToVTK/vtkMesh.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::vtkMesh
  27
  28 Description
  29     Encapsulation of VTK mesh data. Holds mesh or meshsubset and
  30     polyhedral-cell decomposition on it.
  31
  32 SourceFiles
  33     vtkMesh.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef vtkMesh_H
  38 #define vtkMesh_H
  39
  40 #include "vtkTopo.H"
  41 #include "fvMeshSubset.H"
  42 #include "pointMesh.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 // Forward declaration of classes
  50 class Time;
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class vtkMesh Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class vtkMesh
  57 {
  58     // Private data
  59
  60         //- Reference to mesh
  61         fvMesh& baseMesh_;
  62
  63         //- Demand driven pointMesh
  64         mutable autoPtr<pointMesh> pointMeshPtr_;
  65
  66         //- Subsetting engine + sub-fvMesh
  67         fvMeshSubset subsetter_;
  68
  69         //- Current cellSet (or empty)
  70         const word setName_;
  71
  72         //- Current decomposition of topology
  73         mutable autoPtr<vtkTopo> topoPtr_;
  74
  75
  76
  77     // Private Member Functions
  78
  79         //- Disallow default bitwise copy construct
  80         vtkMesh(const vtkMesh&);
  81
  82         //- Disallow default bitwise assignment
  83         void operator=(const vtkMesh&);
  84
  85
  86 public:
  87
  88     // Constructors
  89
  90         //- Construct from components
  91         vtkMesh(fvMesh& baseMesh, const word& setName = "");
  92
  93
  94     // Member Functions
  95
  96         // Access
  97
  98             //- whole mesh
  99             const fvMesh& baseMesh() const
 100             {
 101                 return baseMesh_;
 102             }
 103
 104             const pointMesh& basePointMesh() const
 105             {
 106                 if (!pointMeshPtr_.valid())
 107                 {
 108                     pointMeshPtr_.reset(new pointMesh(baseMesh_));
 109                 }
 110                 return pointMeshPtr_();
 111             }
 112
 113             const fvMeshSubset& subsetter() const
 114             {
 115                 return subsetter_;
 116             }
 117
 118             //- Check if running subMesh
 119             bool useSubMesh() const
 120             {
 121                 return setName_.size() > 0;
 122             }
 123
 124             //- topology
 125             const vtkTopo& topo() const
 126             {
 127                 if (!topoPtr_.valid())
 128                 {
 129                     topoPtr_.reset(new vtkTopo(mesh()));
 130                 }
 131                 return topoPtr_();
 132             }
 133
 134             //- Access either mesh or submesh
 135             const fvMesh& mesh() const
 136             {
 137                 if (useSubMesh())
 138                 {
 139                     return subsetter_.subMesh();
 140                 }
 141                 else
 142                 {
 143                     return baseMesh_;
 144                 }
 145             }
 146
 147             //- Access either pointMesh of base or pointMesh of subset
 148             const pointMesh& pMesh() const
 149             {
 150                 if (useSubMesh())
 151                 {
 152                     return subsetter_.subPointMesh();
 153                 }
 154                 else
 155                 {
 156                     return basePointMesh();
 157                 }
 158             }
 159
 160             //- Number of field cells
 161             label nFieldCells() const
 162             {
 163                 return topo().cellTypes().size();
 164             }
 165
 166             //- Number of field points
 167             label nFieldPoints() const
 168             {
 169                 return pMesh().size() + topo().addPointCellLabels().size();
 170             }
 171
 172
 173         // Edit
 174
 175             //- Read mesh
 176             polyMesh::readUpdateState readUpdate();
 177
 178
 179             //- Map volume field (does in fact do very little interpolation;
 180             //  just copied from fvMeshSubset)
 181             template<class GeoField>
 182             tmp<GeoField> interpolate(const GeoField& fld) const
 183             {
 184                 if (useSubMesh())
 185                 {
 186                     tmp<GeoField> subFld = subsetter_.interpolate(fld);
 187                     subFld().rename(fld.name());
 188                     return subFld;
 189                 }
 190                 else
 191                 {
 192                     return fld;
 193                 }
 194             }
 195 };
 196
 197
 198 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 199
 200 } // End namespace Foam
 201
 202 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 203
 204 #endif
 205
 206 // ************************************************************************* //