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 held by original author
   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
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // Forward declaration of classes
  49 class Time;
  50
  51 /*---------------------------------------------------------------------------*\
  52                            Class vtkMesh Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class vtkMesh
  56 :
  57     public fvMesh
  58 {
  59     // Private data
  60
  61         //- Mesh subset
  62         fvMeshSubset subsetMesh_;
  63
  64         //- Current cellSet (or empty)
  65         const word setName_;
  66
  67         //- Current decomposition of topology
  68         mutable autoPtr<vtkTopo> topoPtr_;
  69
  70
  71
  72     // Private Member Functions
  73
  74         //- Disallow default bitwise copy construct
  75         vtkMesh(const vtkMesh&);
  76
  77         //- Disallow default bitwise assignment
  78         void operator=(const vtkMesh&);
  79
  80
  81 public:
  82
  83     // Constructors
  84
  85         //- Construct from components
  86         vtkMesh(const IOobject& io, const word& setName = "");
  87
  88
  89     // Destructor
  90
  91         virtual ~vtkMesh();
  92
  93
  94     // Member Functions
  95
  96         // Access
  97
  98             const fvMeshSubset& subsetMesh() const
  99             {
 100                 return subsetMesh_;
 101             }
 102
 103             //- Check if running subMesh
 104             bool useSubMesh() const
 105             {
 106                 return setName_.size();
 107             }
 108
 109             //- topology
 110             const vtkTopo& topo() const
 111             {
 112                 if (topoPtr_.empty())
 113                 {
 114                     topoPtr_.reset(new vtkTopo(mesh()));
 115                 }
 116                 return topoPtr_();
 117             }
 118
 119             //- Access either mesh or submesh
 120             const fvMesh& mesh() const
 121             {
 122                 if (useSubMesh())
 123                 {
 124                     return subsetMesh_.subMesh();
 125                 }
 126                 else
 127                 {
 128                     return *this;
 129                 }
 130             }
 131
 132             //- Access either pointMesh of base or pointMesh of subset
 133             const pointMesh& pMesh() const
 134             {
 135                 if (useSubMesh())
 136                 {
 137                     return pointMesh::New(subsetMesh_.subMesh());
 138                 }
 139                 else
 140                 {
 141                     return pointMesh::New(*this);
 142                 }
 143             }
 144
 145             //- Number of field cells
 146             label nFieldCells() const
 147             {
 148                 return topo().cellTypes().size();
 149             }
 150
 151             //- Number of field points
 152             label nFieldPoints() const
 153             {
 154                 return mesh().nPoints() + topo().addPointCellLabels().size();
 155             }
 156
 157
 158         // Edit
 159
 160             //- Read mesh
 161             polyMesh::readUpdateState readUpdate();
 162
 163
 164             //- Map volume field (does in fact do very little interpolation;
 165             //  just copied from fvMeshSubset)
 166             template<class GeoField>
 167             tmp<GeoField> interpolate(const GeoField& fld) const
 168             {
 169                 if (useSubMesh())
 170                 {
 171                     tmp<GeoField> subFld = subsetMesh_.interpolate(fld);
 172                     subFld().rename(fld.name());
 173                     return subFld;
 174                 }
 175                 else
 176                 {
 177                     return fld;
 178                 }
 179             }
 180 };
 181
 182
 183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 184
 185 } // End namespace Foam
 186
 187 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 188
 189 #endif
 190
 191 // ************************************************************************* //