VTK  9.4.20250130
vtkEnSightWriter.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
3// SPDX-License-Identifier: BSD-3-Clause
4
24#ifndef vtkEnSightWriter_h
25#define vtkEnSightWriter_h
26
27#include "vtkIOParallelModule.h" // For export macro
28#include "vtkWriter.h"
29
30VTK_ABI_NAMESPACE_BEGIN
32
33class VTKIOPARALLEL_EXPORT vtkEnSightWriter : public vtkWriter
34{
35
36public:
38 void PrintSelf(ostream& os, vtkIndent indent) override;
39
44
46
49 vtkSetMacro(ProcessNumber, int);
50 vtkGetMacro(ProcessNumber, int);
52
54
60
62
65 vtkSetStringMacro(BaseName);
66 vtkGetStringMacro(BaseName);
68
70
76
78
81 vtkSetMacro(TimeStep, int);
82 vtkGetMacro(TimeStep, int);
84
86
89 vtkSetMacro(GhostLevel, int);
90 vtkGetMacro(GhostLevel, int);
92
94
98 vtkSetMacro(TransientGeometry, bool);
99 vtkGetMacro(TransientGeometry, bool);
101
103
106 vtkSetMacro(NumberOfBlocks, int);
107 vtkGetMacro(NumberOfBlocks, int);
109
111
119 vtkBooleanMacro(WriteNodeIDs, bool);
120 vtkSetMacro(WriteNodeIDs, bool);
121 vtkGetMacro(WriteNodeIDs, bool);
123
125
133 vtkBooleanMacro(WriteElementIDs, bool);
134 vtkSetMacro(WriteElementIDs, bool);
135 vtkGetMacro(WriteElementIDs, bool);
137
139
143 virtual void SetBlockIDs(int* val) { BlockIDs = val; }
144 virtual int* GetBlockIDs() { return BlockIDs; }
146
148
151 virtual void SetInputData(vtkUnstructuredGrid* input);
154
156
163 virtual void WriteCaseFile(int TotalTimeSteps);
164 virtual void WriteSOSCaseFile(int NumProcs);
166
167protected:
170
171 int FillInputPortInformation(int port, vtkInformation* info) override;
173 vtkInformationVector* outputVector) override;
174
175 void WriteData() override; // method to allow this class to be instantiated and delegated to
176
177 virtual void WriteStringToFile(const char* string, FILE* file);
178 virtual void WriteTerminatedStringToFile(const char* string, FILE* file);
179 virtual void WriteIntToFile(int i, FILE* file);
180 virtual void WriteFloatToFile(float f, FILE* file);
181 virtual void WriteElementTypeToFile(int ElementType, FILE* fd);
182
183 virtual bool ShouldWriteGeometry();
184 virtual void SanitizeFileName(char* name);
185 virtual FILE* OpenFile(char* name);
186
189
190 int GetExodusModelIndex(int* ElementArray, int NumberElements, int PartID);
191
192 static int GetDestinationComponent(int srcComponent, int numComponents);
193
194 char* Path;
195 char* BaseName;
196 char* FileName;
208
210 void operator=(const vtkEnSightWriter&) = delete;
211};
212
213VTK_ABI_NAMESPACE_END
214#endif
write vtk unstructured grid data as an EnSight file
virtual vtkUnstructuredGrid * GetInput()
Specify the input data or filter.
virtual void WriteFloatToFile(float f, FILE *file)
vtkSetFilePathMacro(FileName)
Specify the path and base name of the output files.
virtual void WriteSOSCaseFile(int NumProcs)
Writes the case file that EnSight is capable of reading The other data files must be written before t...
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
virtual void SanitizeFileName(char *name)
virtual void WriteTerminatedStringToFile(const char *string, FILE *file)
vtkSetFilePathMacro(Path)
Specify path of EnSight data files to write.
virtual void WriteIntToFile(int i, FILE *file)
vtkUnstructuredGrid * TmpInput
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void SetInputData(vtkUnstructuredGrid *input)
Specify the input data or filter.
void operator=(const vtkEnSightWriter &)=delete
virtual bool ShouldWriteGeometry()
virtual int * GetBlockIDs()
set the array of Block ID's this class keeps a reference to the array and will not delete it
static int GetDestinationComponent(int srcComponent, int numComponents)
virtual void SetBlockIDs(int *val)
set the array of Block ID's this class keeps a reference to the array and will not delete it
virtual void WriteCaseFile(int TotalTimeSteps)
Writes the case file that EnSight is capable of reading The other data files must be written before t...
int GetExodusModelIndex(int *ElementArray, int NumberElements, int PartID)
void WriteData() override
int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
vtkGetFilePathMacro(Path)
Specify path of EnSight data files to write.
vtkGetFilePathMacro(FileName)
Specify the path and base name of the output files.
virtual void WriteStringToFile(const char *string, FILE *file)
virtual void WriteElementTypeToFile(int ElementType, FILE *fd)
virtual FILE * OpenFile(char *name)
vtkEnSightWriter(const vtkEnSightWriter &)=delete
static vtkEnSightWriter * New()
~vtkEnSightWriter() override
a simple class to control print indentation
Definition vtkIndent.h:108
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
dataset represents arbitrary combinations of all possible cell types
abstract class to write data to file(s)
Definition vtkWriter.h:35