applications/utilities/postProcessing/graphics/PVFoamReader/PVFoamReader/vtkFoamReader.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     vtkFoamReader
  27
  28 Description
  29
  30 SourceFiles
  31     vtkFoamReader.cxx
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef vtkFoamReader_h
  36 #define vtkFoamReader_h
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 #include "vtkDataSetSource.h"
  41 #include "vtkFoamData.h"
  42
  43 // * * * * * * * * * * * * * Forward Declarations  * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47     class vtkFoam;
  48 }
  49
  50 class vtkPoints;
  51 class vtkDataArraySelection;
  52 class vtkDataArrayCollection;
  53 class vtkCallbackCommand;
  54
  55 /*---------------------------------------------------------------------------*\
  56                          Class vtkFoamReader Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class VTK_IO_EXPORT vtkFoamReader
  60 :
  61     public vtkDataSetSource
  62 {
  63
  64 public:
  65
  66     //- Standard VTK class creation function
  67     static vtkFoamReader *New();
  68
  69     //- Standard VTK class type and revision declaration macro
  70     vtkTypeRevisionMacro(vtkFoamReader,vtkDataSetSource);
  71
  72     //- Standard VTK class print function
  73     void PrintSelf(ostream& os, vtkIndent indent);
  74
  75     // File name of FOAM datafile to read
  76     void SetFileName(const char *);
  77     //vtkSetStringMacro(FileName);
  78     vtkGetStringMacro(FileName);
  79
  80     // GUI update control
  81     vtkSetMacro(UpdateGUI, int);
  82     vtkGetMacro(UpdateGUI, int);
  83
  84     // FOAM mesh caching control
  85     vtkSetMacro(CacheMesh, int);
  86     vtkGetMacro(CacheMesh, int);
  87
  88     // Time-step slider control
  89     vtkSetMacro(TimeStep, int);
  90     vtkGetMacro(TimeStep, int);
  91     vtkSetVector2Macro(TimeStepRange, int);
  92     vtkGetVector2Macro(TimeStepRange, int);
  93
  94     // Control of the upper and lower limits on the number of times
  95     // displayed in the selection list
  96     vtkSetVector2Macro(TimeStepLimits, int);
  97     vtkGetVector2Macro(TimeStepLimits, int);
  98
  99     // Time selection list control
 100     vtkDataArraySelection* GetTimeSelection();
 101     int GetNumberOfTimeArrays();
 102     const char* GetTimeArrayName(int index);
 103     int GetTimeArrayStatus(const char* name);
 104     void SetTimeArrayStatus(const char* name, int status);
 105
 106     // Region selection list control
 107     vtkDataArraySelection* GetRegionSelection();
 108     int GetNumberOfRegionArrays();
 109     const char* GetRegionArrayName(int index);
 110     int GetRegionArrayStatus(const char* name);
 111     void SetRegionArrayStatus(const char* name, int status);
 112
 113     // volField selection list control
 114     vtkDataArraySelection* GetVolFieldSelection();
 115     int GetNumberOfVolFieldArrays();
 116     const char* GetVolFieldArrayName(int index);
 117     int GetVolFieldArrayStatus(const char* name);
 118     void SetVolFieldArrayStatus(const char* name, int status);
 119
 120     // pointField selection list control
 121     vtkDataArraySelection* GetPointFieldSelection();
 122     int GetNumberOfPointFieldArrays();
 123     const char* GetPointFieldArrayName(int index);
 124     int GetPointFieldArrayStatus(const char* name);
 125     void SetPointFieldArrayStatus(const char* name, int status);
 126
 127     // SetNthOutput provided so that vtkFoam can access it
 128     void SetNthOutput(int num, vtkDataObject *output)
 129     {
 130         vtkDataSetSource::SetNthOutput(num, output);
 131     }
 132
 133     // Standard VTK ExecuteInformation function overriding the base-class.
 134     // Called by ParaView before GUI is displayed.
 135     virtual void ExecuteInformation();
 136
 137     // Callback registered with the SelectionObserver
 138     // for all the selection lists
 139     static void SelectionModifiedCallback
 140     (
 141         vtkObject* caller,
 142         unsigned long eid,
 143         void* clientdata,
 144         void* calldata
 145     );
 146
 147     void SelectionModified();
 148
 149
 150 protected:
 151
 152     vtkFoamReader();
 153     ~vtkFoamReader();
 154
 155     // Standard VTK execute function overriding the base-class.
 156     // Called by ParaView when Accept is pressed.
 157     void Execute();
 158
 159     // Cache for the outputs.  These are stored before the end of Execute()
 160     // and re-instated at the beginning because the Outputs would disappear
 161     // otherwise.
 162     vtkFoamData* StoredOutputs;
 163
 164     // FOAM file name (*.foam)
 165     char *FileName;
 166
 167     //BTX
 168     Foam::vtkFoam* foamData_;
 169     //ETX
 170
 171     int CacheMesh;
 172
 173     int UpdateGUI;
 174     int UpdateGUIOld;
 175     int TimeStep;
 176     int TimeStepRange[2];
 177
 178     int TimeStepLimits[2];
 179
 180     vtkDataArraySelection* TimeSelection;
 181     vtkDataArraySelection* RegionSelection;
 182     vtkDataArraySelection* VolFieldSelection;
 183     vtkDataArraySelection* PointFieldSelection;
 184
 185     // The observer to modify this object when the array selections are modified
 186     vtkCallbackCommand* SelectionObserver;
 187
 188
 189 private:
 190
 191     vtkFoamReader(const vtkFoamReader&);  // Not implemented.
 192     void operator=(const vtkFoamReader&);  // Not implemented.
 193 };
 194
 195
 196 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 197
 198 #endif
 199
 200 // ************************************************************************* //