VTK  9.2.5
vtkXdmf3Writer.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkXdmf3Writer.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
15
29#ifndef vtkXdmf3Writer_h
30#define vtkXdmf3Writer_h
31
32#include "vtkIOXdmf3Module.h" // For export macro
33
35
36class vtkDoubleArray;
37
38class VTKIOXDMF3_EXPORT vtkXdmf3Writer : public vtkDataObjectAlgorithm
39{
40public:
43 void PrintSelf(ostream& os, vtkIndent indent) override;
44
48 virtual void SetInputData(vtkDataObject* dobj);
49
51
57
59
63 void SetGhostLevel(int) {}
64 int GetGhostLevel() { return 0; }
66
72 virtual int Write();
73
75
79 vtkSetMacro(LightDataLimit, unsigned int);
80 vtkGetMacro(LightDataLimit, unsigned int);
82
84
89 vtkSetMacro(WriteAllTimeSteps, bool);
90 vtkGetMacro(WriteAllTimeSteps, bool);
91 vtkBooleanMacro(WriteAllTimeSteps, bool);
93
94protected:
96 ~vtkXdmf3Writer() override;
97
98 // Overridden to set up automatic loop over time steps.
100 // Overridden to continue automatic loop over time steps.
102 // Write out the input data objects as XDMF and HDF output files.
104
105 char* FileName;
106 unsigned int LightDataLimit;
110
114 int CheckParametersInternal(int numberOfProcesses, int myRank);
115 virtual int CheckParameters();
116 // If writing in parallel multiple time steps exchange after each time step
117 // if we should continue the execution. Pass local continueExecution as a
118 // parameter and return the global continueExecution.
119 virtual int GlobalContinueExecuting(int localContinueExecution);
120
122
123private:
124 vtkXdmf3Writer(const vtkXdmf3Writer&) = delete;
125 void operator=(const vtkXdmf3Writer&) = delete;
126
127 class Internals;
128 Internals* Internal;
129};
130
131#endif /* vtkXdmf3Writer_h */
Superclass for algorithms that produce only data object as output.
general representation of visualization data
Definition: vtkDataObject.h:66
dynamic, self-adjusting array of double
a simple class to control print indentation
Definition: vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
write eXtensible Data Model and Format files
int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
~vtkXdmf3Writer() override
vtkDataObject * OriginalInput
void WriteDataInternal(vtkInformation *request)
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
int CheckParametersInternal(int numberOfProcesses, int myRank)
void SetGhostLevel(int)
We never write out ghost cells.
vtkSetFilePathMacro(FileName)
Set or get the file name of the xdmf file.
virtual int CheckParameters()
virtual int GlobalContinueExecuting(int localContinueExecution)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkGetFilePathMacro(FileName)
Set or get the file name of the xdmf file.
virtual void SetInputData(vtkDataObject *dobj)
Set the input data set.
virtual int Write()
Write data to output.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
vtkDoubleArray * TimeValues
static vtkXdmf3Writer * New()
unsigned int LightDataLimit
int GetGhostLevel()
We never write out ghost cells.