vtkExodusIIWriter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkExodusIIWriter_h
#define vtkExodusIIWriter_h
 
#include "vtkIOExodusModule.h" // For export macro
#include "vtkSmartPointer.h"   // For vtkSmartPointer
#include "vtkWriter.h"
 
#include <map>    // STL Header
#include <string> // STL Header
#include <vector> // STL Header
 
VTK_ABI_NAMESPACE_BEGIN
class vtkModelMetadata;
class vtkDoubleArray;
class vtkIntArray;
class vtkUnstructuredGrid;
 
class VTKIOEXODUS_EXPORT vtkExodusIIWriter : public vtkWriter
{
public:
  static vtkExodusIIWriter* New();
  vtkTypeMacro(vtkExodusIIWriter, vtkWriter);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void SetModelMetadata(vtkModelMetadata*);
  vtkGetObjectMacro(ModelMetadata, vtkModelMetadata);
 
  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);
 
  vtkSetMacro(StoreDoubles, int);
  vtkGetMacro(StoreDoubles, int);
 
  vtkSetMacro(GhostLevel, int);
  vtkGetMacro(GhostLevel, int);
 
  vtkSetMacro(WriteOutBlockIdArray, vtkTypeBool);
  vtkGetMacro(WriteOutBlockIdArray, vtkTypeBool);
  vtkBooleanMacro(WriteOutBlockIdArray, vtkTypeBool);
 
  vtkSetMacro(WriteOutGlobalNodeIdArray, vtkTypeBool);
  vtkGetMacro(WriteOutGlobalNodeIdArray, vtkTypeBool);
  vtkBooleanMacro(WriteOutGlobalNodeIdArray, vtkTypeBool);
 
  vtkSetMacro(WriteOutGlobalElementIdArray, vtkTypeBool);
  vtkGetMacro(WriteOutGlobalElementIdArray, vtkTypeBool);
  vtkBooleanMacro(WriteOutGlobalElementIdArray, vtkTypeBool);
 
  vtkSetMacro(WriteAllTimeSteps, vtkTypeBool);
  vtkGetMacro(WriteAllTimeSteps, vtkTypeBool);
  vtkBooleanMacro(WriteAllTimeSteps, vtkTypeBool);
 
  vtkSetStringMacro(BlockIdArrayName);
  vtkGetStringMacro(BlockIdArrayName);
 
  vtkSetMacro(IgnoreMetaDataWarning, bool);
  vtkGetMacro(IgnoreMetaDataWarning, bool);
  vtkBooleanMacro(IgnoreMetaDataWarning, bool);
 
protected:
  vtkExodusIIWriter();
  ~vtkExodusIIWriter() override;
 
  vtkModelMetadata* ModelMetadata;
 
  char* BlockIdArrayName;
 
  char* FileName;
  int fid;
 
  int NumberOfProcesses;
  int MyRank;
 
  int PassDoubles;
 
  int StoreDoubles;
  int GhostLevel;
  vtkTypeBool WriteOutBlockIdArray;
  vtkTypeBool WriteOutGlobalNodeIdArray;
  vtkTypeBool WriteOutGlobalElementIdArray;
  vtkTypeBool WriteAllTimeSteps;
  int NumberOfTimeSteps;
 
  int CurrentTimeIndex;
  int FileTimeOffset;
  bool TopologyChanged;
  bool IgnoreMetaDataWarning;
 
  vtkDataObject* OriginalInput;
  std::vector<vtkSmartPointer<vtkUnstructuredGrid>> FlattenedInput;
  std::vector<vtkSmartPointer<vtkUnstructuredGrid>> NewFlattenedInput;
 
  std::vector<vtkStdString> FlattenedNames;
  std::vector<vtkStdString> NewFlattenedNames;
 
  std::vector<vtkIntArray*> BlockIdList;
 
  struct Block
  {
    Block()
    {
      this->Name = nullptr;
      this->Type = 0;
      this->NumElements = 0;
      this->ElementStartIndex = -1;
      this->NodesPerElement = 0;
      this->EntityCounts = std::vector<int>();
      this->EntityNodeOffsets = std::vector<int>();
      this->GridIndex = 0;
      this->OutputIndex = -1;
      this->NumAttributes = 0;
      this->BlockAttributes = nullptr;
    }
    const char* Name;
    int Type;
    int NumElements;
    int ElementStartIndex;
    int NodesPerElement;
    std::vector<int> EntityCounts;
    std::vector<int> EntityNodeOffsets;
    size_t GridIndex;
    // std::vector<int> CellIndex;
    int OutputIndex;
    int NumAttributes;
    float* BlockAttributes; // Owned by metamodel or null.  Don't delete.
  };
  std::map<int, Block> BlockInfoMap;
  int NumCells, NumPoints, MaxId;
 
  std::vector<vtkIdType*> GlobalElementIdList;
  std::vector<vtkIdType*> GlobalNodeIdList;
 
  int AtLeastOneGlobalElementIdList;
  int AtLeastOneGlobalNodeIdList;
 
  struct VariableInfo
  {
    int NumComponents;
    int InIndex;
    int ScalarOutOffset;
    std::vector<std::string> OutNames;
  };
  std::map<std::string, VariableInfo> GlobalVariableMap;
  std::map<std::string, VariableInfo> BlockVariableMap;
  std::map<std::string, VariableInfo> NodeVariableMap;
  int NumberOfScalarGlobalArrays;
  int NumberOfScalarElementArrays;
  int NumberOfScalarNodeArrays;
 
  std::vector<std::vector<int>> CellToElementOffset;
 
  // By BlockId, and within block ID by element variable, with variables
  // appearing in the same order in which they appear in OutputElementArrayNames
 
  int* BlockElementVariableTruthTable;
  int AllVariablesDefinedInAllBlocks;
 
  int BlockVariableTruthValue(int blockIdx, int varIdx);
 
  char* StrDupWithNew(const char* s);
  void StringUppercase(std::string& str);
 
  vtkTypeBool ProcessRequest(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
 
  int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector);
 
  virtual int RequestUpdateExtent(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector);
 
  int FillInputPortInformation(int port, vtkInformation* info) override;
 
  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
 
  void WriteData() override;
 
  int FlattenHierarchy(vtkDataObject* input, const char* name, bool& changed);
 
  int CreateNewExodusFile();
  void CloseExodusFile();
 
  int IsDouble();
  void RemoveGhostCells();
  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);
  int CheckInputArrays();
  virtual void CheckBlockInfoMap();
  int ConstructBlockInfoMap();
  int ConstructVariableInfoMaps();
  int ParseMetadata();
  int CreateDefaultMetadata();
  char* GetCellTypeName(int t);
 
  int CreateBlockIdMetadata(vtkModelMetadata* em);
  int CreateBlockVariableMetadata(vtkModelMetadata* em);
  int CreateSetsMetadata(vtkModelMetadata* em);
 
  void ConvertVariableNames(std::map<std::string, VariableInfo>& variableMap);
  char** FlattenOutVariableNames(
    int nScalarArrays, const std::map<std::string, VariableInfo>& variableMap);
  std::string CreateNameForScalarArray(const char* root, int component, int numComponents);
 
  std::map<vtkIdType, vtkIdType>* LocalNodeIdMap;
  std::map<vtkIdType, vtkIdType>* LocalElementIdMap;
 
  vtkIdType GetNodeLocalId(vtkIdType id);
  vtkIdType GetElementLocalId(vtkIdType id);
  int GetElementType(vtkIdType id);
 
  int WriteInitializationParameters();
  int WriteInformationRecords();
  int WritePoints();
  int WriteCoordinateNames();
  int WriteGlobalPointIds();
  int WriteBlockInformation();
  int WriteGlobalElementIds();
  int WriteVariableArrayNames();
  int WriteNodeSetInformation();
  int WriteSideSetInformation();
  int WriteProperties();
  int WriteNextTimeStep();
  vtkIntArray* GetBlockIdArray(const char* BlockIdArrayName, vtkUnstructuredGrid* input);
  static bool SameTypeOfCells(vtkIntArray* cellToBlockId, vtkUnstructuredGrid* input);
 
  double ExtractGlobalData(const char* name, int comp, int ts);
  int WriteGlobalData(int timestep, vtkDataArray* buffer);
  void ExtractCellData(const char* name, int comp, vtkDataArray* buffer);
  int WriteCellData(int timestep, vtkDataArray* buffer);
  void ExtractPointData(const char* name, int comp, vtkDataArray* buffer);
  int WritePointData(int timestep, vtkDataArray* buffer);
 
  virtual unsigned int GetMaxNameLength();
 
private:
  vtkExodusIIWriter(const vtkExodusIIWriter&) = delete;
  void operator=(const vtkExodusIIWriter&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif