VTKOutput.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2020 Total, S.A
 * Copyright (c) 2019-     GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */

#ifndef GEOSX_MANAGERS_OUTPUTS_VTKOUTPUT_HPP_
#define GEOSX_MANAGERS_OUTPUTS_VTKOUTPUT_HPP_

#include "OutputBase.hpp"
#include "fileIO/vtk/VTKPolyDataWriterInterface.hpp"


namespace geosx
{

class VTKOutput : public OutputBase
{
public:

  VTKOutput( std::string const & name, Group * const parent );

  virtual ~VTKOutput() override;

  static string CatalogName() { return "VTK"; }

  virtual void Execute( real64 const time_n,
                        real64 const dt,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        dataRepository::Group * domain ) override;

  virtual void Cleanup( real64 const time_n,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        dataRepository::Group * domain ) override
  {
    Execute( time_n, 0, cycleNumber, eventCounter, eventProgress, domain );
  }

  struct viewKeysStruct : OutputBase::viewKeysStruct
  {
    static constexpr auto plotFileRoot = "plotFileRoot";
    static constexpr auto writeFEMFaces = "writeFEMFaces";
    static constexpr auto plotLevel = "plotLevel";
    static constexpr auto binaryString = "writeBinaryData";

  } vtkOutputViewKeys;

private:
  string m_plotFileRoot;
  integer m_writeFaceMesh;
  integer m_plotLevel;

  integer m_writeBinaryData;

  vtk::VTKPolyDataWriterInterface m_writer;

};


} /* namespace geosx */

#endif /* GEOSX_MANAGERS_OUTPUTS_VTKOUTPUT_HPP_ */