VTKOutput.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_FILEIO_OUTPUTS_VTKOUTPUT_HPP_
#define GEOS_FILEIO_OUTPUTS_VTKOUTPUT_HPP_
 
#include "OutputBase.hpp"
#include "fileIO/vtk/VTKPolyDataWriterInterface.hpp"
 
 
namespace geos
{
 
class VTKOutput : public OutputBase
{
public:
 
  VTKOutput( string const & name, Group * const parent );
 
  virtual ~VTKOutput() override;
 
  static string catalogName() { return "VTK"; }
 
  virtual void postInputInitialization() override;
 
  void setPlotFileRoot( string const & root );
 
  virtual bool execute( real64 const time_n,
                        real64 const dt,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        DomainPartition & domain ) override;
 
  virtual void cleanup( real64 const time_n,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        DomainPartition & domain ) override
  {
    execute( time_n, 0, cycleNumber, eventCounter, eventProgress, domain );
 
    // Call parent class cleanup to get the timing statistics
    OutputBase::cleanup( time_n, cycleNumber, eventCounter, eventProgress, domain );
  }
 
  virtual void reinit() override;
 
  struct viewKeysStruct : OutputBase::viewKeysStruct
  {
    static constexpr auto plotFileRoot = "plotFileRoot";
    static constexpr auto writeFEMFaces = "writeFEMFaces";
    static constexpr auto writeGhostCells = "writeGhostCells";
    static constexpr auto writeFaceElementsAs3D = "writeFaceElementsAs3D";
    static constexpr auto plotLevel = "plotLevel";
    static constexpr auto binaryString = "format";
    static constexpr auto outputRegionTypeString = "outputRegionType";
    static constexpr auto onlyPlotSpecifiedFieldNames = "onlyPlotSpecifiedFieldNames";
    static constexpr auto fieldNames = "fieldNames";
    static constexpr auto levelNames = "levelNames";
    static constexpr auto numberOfTargetProcesses = "numberOfTargetProcesses";
  } vtkOutputViewKeys;
 
#if defined(GEOS_USE_PYGEOSX)
  virtual PyTypeObject * getPythonType() const override;
#endif
 
protected:
  logInfo::OutputTimerBase const & getTimerCategory() const override;
 
private:
 
  string m_plotFileRoot;
  integer m_writeFaceMesh;
  integer m_plotLevel;
 
  integer m_numberOfTargetProcesses;
 
  integer m_writeGhostCells;
 
  integer m_writeFaceElementsAs3D;
 
  integer m_onlyPlotSpecifiedFieldNames;
 
  array1d< string > m_fieldNames;
 
  array1d< string > m_levelNames;
 
  vtk::VTKOutputMode m_writeBinaryData = vtk::VTKOutputMode::BINARY;
 
  vtk::VTKRegionTypes m_outputRegionType = vtk::VTKRegionTypes::ALL;
 
  vtk::VTKPolyDataWriterInterface m_writer;
 
};
 
 
} /* namespace geos */
 
#endif /* GEOS_FILEIO_OUTPUTS_VTKOUTPUT_HPP_ */