1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
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
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkAMReXParticlesReader
* @brief reader for AMReX plotfiles particle data.
*
* vtkAMReXParticlesReader readers particle data from AMReX plotfiles. The
* reader is based on the `ParticleContainer::Restart` and
* `amrex_binary_particles_to_vtp` files in the
* [AMReX code](https://amrex-codes.github.io/).
*
* The reader reads all levels in as blocks in output multiblock dataset
* distributed datasets at each level between ranks in a contiguous fashion.
*
* To use the reader, one must set the `PlotFileName` and `ParticleType` which
* identifies the type particles from the PlotFileName to read.
*
* The reader provides ability to select point data arrays to be made available
* in the output. Note that due to the nature of the file structure, all
* variables are still read in and hence deselecting arrays does not reduce I/O
* calls or initial memory requirements.
*/
#ifndef vtkAMReXParticlesReader_h
#define vtkAMReXParticlesReader_h
#include "vtkIOAMRModule.h" // For export macro
#include "vtkMultiBlockDataSetAlgorithm.h"
#include "vtkNew.h" // for vtkNew
#include <string> // for std::string.
VTK_ABI_NAMESPACE_BEGIN
class vtkDataArraySelection;
class vtkMultiPieceDataSet;
class vtkMultiProcessController;
class VTKIOAMR_EXPORT vtkAMReXParticlesReader : public vtkMultiBlockDataSetAlgorithm
{
public:
static vtkAMReXParticlesReader* New();
vtkTypeMacro(vtkAMReXParticlesReader, vtkMultiBlockDataSetAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent) override;
///@{
/**
* Get/Set the AMReX plotfile. Note this is a directory on the filesystem and
* not the file.
*/
void SetPlotFileName(VTK_FILEPATH const char* fname);
VTK_FILEPATH const char* GetPlotFileName() const;
///@}
///@{
/**
* Get/Set the particle type to read. By default, this is set to 'particles'.
*/
void SetParticleType(const std::string& str);
const std::string& GetParticleType() const { return this->ParticleType; }
///@}
/**
* Get vtkDataArraySelection instance to select point arrays to read. Due to
* the nature of the AMReX particles files, all point data is read in from the
* disk, despite certain arrays unselected. The unselected arrays will be
* discarded from the generated output dataset.
*/
vtkDataArraySelection* GetPointDataArraySelection() const;
/**
* Returns 1 is fname refers to a plotfile that the reader can read.
*/
static int CanReadFile(VTK_FILEPATH const char* fname, const char* particlesType = nullptr);
///@{
/**
* Get/Set the controller to use. By default, the global
* vtkMultiProcessController will be used.
*/
void SetController(vtkMultiProcessController* controller);
vtkGetObjectMacro(Controller, vtkMultiProcessController);
///@}
protected:
vtkAMReXParticlesReader();
~vtkAMReXParticlesReader() override;
int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
vtkMultiProcessController* Controller;
std::string PlotFileName;
bool GenerateGlobalIds;
private:
vtkAMReXParticlesReader(const vtkAMReXParticlesReader&) = delete;
void operator=(const vtkAMReXParticlesReader&) = delete;
/**
* Reads the header and fills up this->Header data-structure.
*/
bool ReadMetaData();
/**
* Reads a level. Blocks in the level are distributed among pieces in a
* contiguous fashion.
*/
bool ReadLevel(int level, vtkMultiPieceDataSet* pdataset, int piece_idx, int num_pieces) const;
vtkTimeStamp PlotFileNameMTime;
vtkTimeStamp MetaDataMTime;
std::string ParticleType;
double dataTimeStep;
vtkNew<vtkDataArraySelection> PointDataArraySelection;
class AMReXParticleHeader;
AMReXParticleHeader* Header;
friend class AMReXParticleHeader;
};
VTK_ABI_NAMESPACE_END
#endif
|
