VtkWriter.hpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
 
   CEPS is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#pragma once
 
#include <vtkCellData.h>
#include <vtkDoubleArray.h>
#include <vtkPointData.h>
#include <vtkSmartPointer.h>
 
#include <vtkIdTypeArray.h>
#include <vtkLine.h>
#include <vtkQuadraticEdge.h>
#include <vtkQuadraticTetra.h>
#include <vtkQuadraticTriangle.h>
#include <vtkTetra.h>
#include <vtkTriangle.h>
#include <vtkUnstructuredGrid.h>
#include <vtkUnstructuredGridWriter.h>
#include <vtkVertex.h>
#include <vtkXMLPUnstructuredGridWriter.h>
 
#include <vtkMPIController.h>
#include <vtkMPICommunicator.h>
#include <vtkMPI.h>
 
#include "common/CepsCommon.hpp"
#include "geometry/Geometry.hpp"
#include "linearAlgebra/LinearAlgebra.hpp"
#include "pde/common/AbstractDiscretization.hpp"
 
class VtkWriter : public CepsObject
{
 
  public:
  
    VtkWriter() = delete;
 
    VtkWriter(AbstractDiscretization* discr,
              const CepsString&       name,
              CepsUInt                nOutputs,
              CepsOutputFormat        outputFormat, 
              CepsBool                writeGlobalIndices = false);
 
    ~VtkWriter() override;
 
    void
    addScalarData(const DHVecPtr& v, const CepsVector<CepsString>& fieldNames, 
                  const CepsVector<Unknown*>& us);
 
    void
    addScalarData(const DHVecPtr& v, const CepsString& fieldName, Unknown* u);
 
    void
    write(CepsReal time = 0., CepsBool writeXmlEntry = true);
 
    CepsString
    getByeByeMessage();
 
    void
    setOutputType(CepsOutputFormat flag);
 
    CepsOutputFormat
    getOutputType() const;
 
    CepsString 
    getOuputExtension() const;
 
  protected:
    // ======================================================================================================
    // Write functions
 
    void 
    writeVTU();
 
    void
    writeLegacyVTK();
 
    void
    writeDataArray();
 
    void 
    writeSeriesFile();
 
    //void
    //writeParaviewFile();
 
    void 
    writeMetaDataSet();
 
    // ======================================================================================================
    // Data
 
    void
    updateMeshData();
  
    void
    insertPointData();
  
    void
    insertElementData();
  
    void
    insertElementsOfDim(CepsUInt dim);
  
    void
    insertCell(GeomCell* cell);
  
    vtkCell *
    allocateCellOfDim(CepsUInt dim);
 
    void
    addTimeFieldToUGrid(CepsReal time);
 
 
  protected:
  
    AbstractDiscretization* m_discr;        
    Geometry*               m_geom;         
    CepsVector<CepsReal>    m_writtenTimes; 
 
    CepsString    m_baseName;    
    CepsUInt      m_outputNb;    
    CepsUInt      m_outputLgMax; 
    CepsString    m_outputDir;   
 
    CepsUInt         m_internalIndex;    
    CepsOutputFormat m_outputType;       
    CepsBool         m_updateMesh;       
    CepsBool         m_writeGeomIndices; 
  
    vtkSmartPointer<vtkUnstructuredGrid> m_unstructuredGrid; 
  
    std::map<CepsUInt, CepsUInt> m_geomToVtkNodeIndex; 
    std::map<CepsUInt, CepsUInt> m_geomToVtkCellIndex; 
  
    // Tools to handle the writing of pvtu file on multiple processors
    vtkSmartPointer<vtkMPICommunicator> m_vtkMpiComm;       
    vtkMPICommunicatorOpaqueComm        m_opaqueCommVTK;    
    vtkSmartPointer<vtkMPIController>   m_vtkMpiController; 
};