vtkXdmfWriter.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 vtkXdmfWriter_h
#define vtkXdmfWriter_h
 
#include "vtkIOXdmf2Module.h" // For export macro
 
#include "vtkDataObjectAlgorithm.h"
 
#include <string> // Needed for private members
#include <vector> //
 
namespace xdmf2
{
class XdmfArray;
class XdmfDOM;
class XdmfElement;
class XdmfGrid;
class XdmfGeometry;
class XdmfTopology;
}
 
VTK_ABI_NAMESPACE_BEGIN
class vtkExecutive;
 
class vtkCompositeDataSet;
class vtkDataArray;
class vtkDataSet;
class vtkDataObject;
class vtkFieldData;
class vtkInformation;
class vtkInformationVector;
class vtkXdmfWriterDomainMemoryHandler;
 
class VTKIOXDMF2_EXPORT vtkXdmfWriter : public vtkDataObjectAlgorithm
{
public:
  static vtkXdmfWriter* New();
  vtkTypeMacro(vtkXdmfWriter, vtkDataObjectAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual void SetInputData(vtkDataObject* dobj);


  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);


  vtkSetFilePathMacro(HeavyDataFileName);
  vtkGetFilePathMacro(HeavyDataFileName);


  vtkSetStringMacro(HeavyDataGroupName);
  vtkGetStringMacro(HeavyDataGroupName);

  virtual int Write();


  vtkSetMacro(LightDataLimit, int);
  vtkGetMacro(LightDataLimit, int);


  vtkSetMacro(WriteAllTimeSteps, int);
  vtkGetMacro(WriteAllTimeSteps, int);
  vtkBooleanMacro(WriteAllTimeSteps, int);


  vtkSetMacro(MeshStaticOverTime, bool);
  vtkGetMacro(MeshStaticOverTime, bool);
  vtkBooleanMacro(MeshStaticOverTime, bool);


  vtkSetMacro(Piece, int);
  vtkSetMacro(NumberOfPieces, int);
 
  // TODO: control choice of heavy data format (xml, hdf5, sql, raw)
 
  // TODO: These controls are available in vtkXdmfWriter, but are not used here.
  // GridsOnly
  // Append to Domain
 
protected:
  vtkXdmfWriter();
  ~vtkXdmfWriter() override;
 
  // Choose composite executive by default for time.
  vtkExecutive* CreateDefaultExecutive() override;
 
  // Can take any one data object
  int FillInputPortInformation(int port, vtkInformation* info) override;
 
  // Overridden to ...
  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  // Overridden to ...
  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  // Overridden to ...
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  // These do the work: recursively parse down input's structure all the way to arrays,
  // use XDMF lib to dump everything to file.
 
  virtual int CreateTopology(vtkDataSet* ds, xdmf2::XdmfGrid* grid, vtkIdType PDims[3],
    vtkIdType CDims[3], vtkIdType& PRank, vtkIdType& CRank, void* staticdata);
  virtual int CreateGeometry(vtkDataSet* ds, xdmf2::XdmfGrid* grid, void* staticdata);
 
  virtual int WriteDataSet(vtkDataObject* dobj, xdmf2::XdmfGrid* grid);
  virtual int WriteCompositeDataSet(vtkCompositeDataSet* dobj, xdmf2::XdmfGrid* grid);
  virtual int WriteAtomicDataSet(vtkDataObject* dobj, xdmf2::XdmfGrid* grid);
  virtual int WriteArrays(vtkFieldData* dsa, xdmf2::XdmfGrid* grid, int association, vtkIdType rank,
    vtkIdType* dims, const char* name);
  virtual void ConvertVToXArray(vtkDataArray* vda, xdmf2::XdmfArray* xda, vtkIdType rank,
    vtkIdType* dims, int AllocStrategy, const char* heavyprefix);
 
  virtual void SetupDataArrayXML(xdmf2::XdmfElement*, xdmf2::XdmfArray*) const;
 
  char* FileName;
  char* HeavyDataFileName;
  char* HeavyDataGroupName;
  std::string WorkingDirectory;
  std::string BaseFileName;
 
  int LightDataLimit;
 
  int WriteAllTimeSteps;
  int NumberOfTimeSteps;
  double CurrentTime;
  int CurrentTimeIndex;
  int CurrentBlockIndex;
  int UnlabelledDataArrayId;
 
  int Piece;
  int NumberOfPieces;
 
  bool MeshStaticOverTime;
 
  xdmf2::XdmfDOM* DOM;
  xdmf2::XdmfGrid* TopTemporalGrid;
 
  vtkXdmfWriterDomainMemoryHandler* DomainMemoryHandler;
 
  std::vector<xdmf2::XdmfTopology*> TopologyAtT0;
  std::vector<xdmf2::XdmfGeometry*> GeometryAtT0;
 
private:
  vtkXdmfWriter(const vtkXdmfWriter&) = delete;
  void operator=(const vtkXdmfWriter&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif /* vtkXdmfWriter_h */