146 lines
4.7 KiB
C++
146 lines
4.7 KiB
C++
/*=========================================================================
|
|
|
|
Program: Visualization Toolkit
|
|
Module: vtkIOSSWriter.h
|
|
|
|
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
|
|
All rights reserved.
|
|
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
|
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even
|
|
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
PURPOSE. See the above copyright notice for more information.
|
|
|
|
=========================================================================*/
|
|
/**
|
|
* @class vtkIOSSWriter
|
|
* @brief writer using IOSS
|
|
*
|
|
* vtkIOSSWriter is a writer to write datasets using IOSS library. Currently
|
|
* this writer supports writing Exodus files. This writer is a work in progress
|
|
* and currently only supports targeted use-cases. The writer will be
|
|
* iteratively cleaned up and fixed to support all types of incoming datasets.
|
|
*/
|
|
|
|
#ifndef vtkIOSSWriter_h
|
|
#define vtkIOSSWriter_h
|
|
|
|
#include "vtkDataObjectAlgorithm.h"
|
|
#include "vtkIOIOSSModule.h" // for export macros
|
|
|
|
#include <memory> // for std::unique_ptr
|
|
|
|
class vtkMultiProcessController;
|
|
|
|
class VTKIOIOSS_EXPORT vtkIOSSWriter : public vtkDataObjectAlgorithm
|
|
{
|
|
public:
|
|
static vtkIOSSWriter* New();
|
|
vtkTypeMacro(vtkIOSSWriter, vtkDataObjectAlgorithm);
|
|
void PrintSelf(ostream& os, vtkIndent indent) override;
|
|
|
|
///@{
|
|
/**
|
|
* Get/set the filename. When writing in a distributed environment, the
|
|
* actual filename written out may be different.
|
|
*/
|
|
vtkSetStringMacro(FileName);
|
|
vtkGetStringMacro(FileName);
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* Exodus wants global ids to start with 1, while VTK generally produces
|
|
* global ids starting with 0. Set this to true (default false), if the global
|
|
* ids are generated by VTK and hence start with 0. When writing to the output
|
|
* file, they will be offset by 1 to ensure the ids are valid exodus ids.
|
|
*/
|
|
vtkSetMacro(OffsetGlobalIds, bool);
|
|
vtkGetMacro(OffsetGlobalIds, bool);
|
|
vtkBooleanMacro(OffsetGlobalIds, bool);
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* If input is untransformed IOSS dataset, then the writer can preserve entity
|
|
* group classifications, such as element blocks, side sets etc. The same is
|
|
* not true if the input has been transformed e.g. through a clip filter. Thus
|
|
* flag is used to indicate whether the input has valid element
|
|
* classifications.
|
|
*/
|
|
vtkSetMacro(PreserveInputEntityGroups, bool);
|
|
vtkGetMacro(PreserveInputEntityGroups, bool);
|
|
vtkBooleanMacro(PreserveInputEntityGroups, bool);
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* If input dataset has displacements pre-applied, setting the displacement
|
|
* magnitude to non-zero ensures that the point coordinates in the dataset are
|
|
* correctly transformed using the displacement field array, if present.
|
|
*
|
|
* Defaults to 1.0.
|
|
*/
|
|
vtkSetClampMacro(DisplacementMagnitude, double, 0, VTK_DOUBLE_MAX);
|
|
vtkGetMacro(DisplacementMagnitude, double);
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* A debugging variable, set this to non-zero positive number to save at most
|
|
* the specified number of timesteps in a single file before starting a new
|
|
* one. The writer may start new files (aka restarts) automatically if it
|
|
* determines that the mesh has changed.
|
|
*
|
|
* Defaults to 0 i.e. unlimited timesteps per file.
|
|
*/
|
|
vtkSetClampMacro(MaximumTimeStepsPerFile, int, 0, VTK_INT_MAX);
|
|
vtkGetMacro(MaximumTimeStepsPerFile, int);
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* Get/Set the controller to use when working in parallel. Initialized to
|
|
* `vtkMultiProcessController::GetGlobalController` in the constructor.
|
|
*
|
|
* The controller is used to determine the upstream piece request in
|
|
* RequestUpdateExtent.
|
|
*/
|
|
void SetController(vtkMultiProcessController* controller);
|
|
vtkGetObjectMacro(Controller, vtkMultiProcessController);
|
|
///@}
|
|
|
|
/**
|
|
* Writes the input dataset.
|
|
*/
|
|
bool Write();
|
|
|
|
protected:
|
|
vtkIOSSWriter();
|
|
~vtkIOSSWriter() override;
|
|
|
|
int FillInputPortInformation(int port, vtkInformation* info) override;
|
|
int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
|
|
vtkInformationVector* outputVector) override;
|
|
int RequestUpdateExtent(vtkInformation* request, vtkInformationVector** inputVector,
|
|
vtkInformationVector* outputVector) override;
|
|
int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
|
|
vtkInformationVector* outputVector) override;
|
|
|
|
private:
|
|
vtkIOSSWriter(const vtkIOSSWriter&) = delete;
|
|
void operator=(const vtkIOSSWriter&) = delete;
|
|
|
|
class vtkInternals;
|
|
std::unique_ptr<vtkInternals> Internals;
|
|
|
|
vtkMultiProcessController* Controller;
|
|
char* FileName;
|
|
bool OffsetGlobalIds;
|
|
bool PreserveInputEntityGroups;
|
|
double DisplacementMagnitude;
|
|
int MaximumTimeStepsPerFile;
|
|
};
|
|
|
|
#endif
|