vtkXdmf3Writer.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkXdmf3Writer_h
#define vtkXdmf3Writer_h
 
#include "vtkIOXdmf3Module.h" // For export macro
 
#include "vtkDataObjectAlgorithm.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDoubleArray;
 
class VTKIOXDMF3_EXPORT vtkXdmf3Writer : public vtkDataObjectAlgorithm
{
public:
  static vtkXdmf3Writer* New();
  vtkTypeMacro(vtkXdmf3Writer, vtkDataObjectAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  virtual void SetInputData(vtkDataObject* dobj);
 
 
  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);
 
 
  void SetGhostLevel(int) {}
  int GetGhostLevel() { return 0; }
 
  virtual int Write();
 
 
  vtkSetMacro(LightDataLimit, unsigned int);
  vtkGetMacro(LightDataLimit, unsigned int);
 
 
  vtkSetMacro(WriteAllTimeSteps, bool);
  vtkGetMacro(WriteAllTimeSteps, bool);
  vtkBooleanMacro(WriteAllTimeSteps, bool);
 
protected:
  vtkXdmf3Writer();
  ~vtkXdmf3Writer() override;
 
  // Overridden to set up automatic loop over time steps.
  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  // Overridden to continue automatic loop over time steps.
  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  // Write out the input data objects as XDMF and HDF output files.
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  char* FileName;
  unsigned int LightDataLimit;
  bool WriteAllTimeSteps;
  int NumberOfProcesses;
  int MyRank;
 
  vtkDoubleArray* TimeValues;
  vtkDataObject* OriginalInput;
  void WriteDataInternal(vtkInformation* request);
  int CheckParametersInternal(int numberOfProcesses, int myRank);
  virtual int CheckParameters();
  // If writing in parallel multiple time steps exchange after each time step
  // if we should continue the execution. Pass local continueExecution as a
  // parameter and return the global continueExecution.
  virtual int GlobalContinueExecuting(int localContinueExecution);
 
  bool InitWriters;
 
private:
  vtkXdmf3Writer(const vtkXdmf3Writer&) = delete;
  void operator=(const vtkXdmf3Writer&) = delete;
 
  class Internals;
  Internals* Internal;
};
 
VTK_ABI_NAMESPACE_END
#endif /* vtkXdmf3Writer_h */