vtkPVReaders.H 5.35 KB
Newer Older
1
2
3
4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

Namespace
25
    Foam::vtkPVReaders
26
27
28
29
30
31

Description
    A collection of helper functions when building a reader interface in
    ParaView3.

SourceFiles
32
    vtkPVReaders.C
33
34
35

\*---------------------------------------------------------------------------*/

36
37
#ifndef vtkPVReaders_H
#define vtkPVReaders_H
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

// do not include legacy strstream headers
#ifndef  VTK_EXCLUDE_STRSTREAM_HEADERS
# define VTK_EXCLUDE_STRSTREAM_HEADERS
#endif

#include "className.H"
#include "fileName.H"
#include "stringList.H"
#include "wordList.H"
#include "HashSet.H"


// * * * * * * * * * * * * * Forward Declarations  * * * * * * * * * * * * * //

class vtkDataArraySelection;
class vtkDataSet;
class vtkPoints;
56
class vtkPVFoamReader;
57
58
59
60
61
62
63
64
65
66
67
68
class vtkRenderer;
class vtkTextActor;
class vtkMultiBlockDataSet;
class vtkPolyData;
class vtkUnstructuredGrid;
class vtkIndent;


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{
69
namespace vtkPVReaders
70
71
{
    //- Declare name of the class and its debug switch
72
    NamespaceName("vtkPVReaders");
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

    //- Bookkeeping for GUI checklists and the multi-block organization
    class partInfo
    {
        const char *name_;
        int block_;
        int start_;
        int size_;

    public:

        partInfo(const char *name, const int blockNo=0)
        :
            name_(name),
            block_(blockNo),
            start_(-1),
            size_(0)
        {}

        //- Return the block holding these datasets
        int block() const
        {
            return block_;
        }

        //- Assign block number, return previous value
        int block(int blockNo)
        {
            int prev = block_;
            block_ = blockNo;
            return prev;
        }

        const char* name() const
        {
            return name_;
        }

        int start() const
        {
            return start_;
        }

        int end() const
        {
            return start_ + size_;
        }

        int size() const
        {
            return size_;
        }

        bool empty() const
        {
            return !size_;
        }

        void reset()
        {
            start_ = -1;
            size_ = 0;
        }

        //- Assign new start and reset the size
        void operator=(const int i)
        {
            start_ = i;
            size_ = 0;
        }

        //- Increment the size
        void operator+=(const int n)
        {
            size_ += n;
        }
    };


    //- Convenience method use to convert the readers from VTK 5
    //  multiblock API to the current composite data infrastructure
    void AddToBlock
    (
        vtkMultiBlockDataSet* output,
        vtkDataSet* dataset,
        const partInfo& selector,
        const label datasetNo,
        const std::string& datasetName
    );


    //- Convenience method use to convert the readers from VTK 5
    // multiblock API to the current composite data infrastructure
    vtkDataSet* GetDataSetFromBlock
    (
        vtkMultiBlockDataSet* output,
        const partInfo& selector,
        const label datasetNo
    );

    //- Convenience method use to convert the readers from VTK 5
    // multiblock API to the current composite data infrastructure
    // ununsed at the moment
    label GetNumberOfDataSets
    (
        vtkMultiBlockDataSet* output,
        const partInfo& selector
    );


    //- Retrieve the current selections as a wordHashSet
    wordHashSet getSelected
    (
        vtkDataArraySelection* select
    );


    //- Retrieve a sub-list of the current selections
    wordHashSet getSelected
    (
        vtkDataArraySelection*,
        const partInfo&
    );


    //- Retrieve the current selections
    stringList getSelectedArrayEntries(vtkDataArraySelection*);

    //- Retrieve a sub-list of the current selections
    stringList getSelectedArrayEntries
    (
        vtkDataArraySelection* select,
        const partInfo& selector
    );


    //- Set selection(s)
    void setSelectedArrayEntries
    (
        vtkDataArraySelection*,
        const stringList&
    );



// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

220
} // End namespace vtkPV
221
222
223
224
225
226
227
228

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //