VTKMeshGenerator.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_MESH_GENERATORS_VTKMESHGENERATOR_HPP
#define GEOS_MESH_GENERATORS_VTKMESHGENERATOR_HPP
 
#include "mesh/generators/ExternalMeshGeneratorBase.hpp"
#include "mesh/generators/VTKUtilities.hpp"
#include "mesh/generators/VTKHierarchicalDataSource.hpp"
#include "mesh/mpiCommunications/SpatialPartition.hpp"
 
class vtkDataSet;
 
namespace geos
{
 
class VTKMeshGenerator : public ExternalMeshGeneratorBase
{
public:
 
  VTKMeshGenerator( const string & name,
                    Group * const parent );
 
  static string catalogName() { return "VTKMesh"; }
 
  void fillCellBlockManager( CellBlockManager & cellBlockManager, SpatialPartition & partition ) override;
 
  void importFieldOnArray( Block block,
                           string const & blockName,
                           string const & meshFieldName,
                           bool isMaterialField,
                           dataRepository::WrapperBase & wrapper ) const override;
 
  void freeResources() override;
 
protected:
  void postInputInitialization() override;
 
private:
 
  struct viewKeyStruct : public ExternalMeshGeneratorBase::viewKeyStruct
  {
    constexpr static char const * regionAttributeString() { return "regionAttribute"; }
    constexpr static char const * structuredIndexAttributeString() { return "structuredIndexAttribute"; }
    constexpr static char const * mainBlockNameString() { return "mainBlockName"; }
    constexpr static char const * faceBlockNamesString() { return "faceBlocks"; }
    constexpr static char const * nodesetNamesString() { return "nodesetNames"; }
    constexpr static char const * partitionRefinementString() { return "partitionRefinement"; }
    constexpr static char const * partitionMethodString() { return "partitionMethod"; }
    constexpr static char const * useGlobalIdsString() { return "useGlobalIds"; }
    constexpr static char const * dataSourceString() { return "dataSourceName"; }
  };
 
  struct groupKeyStruct
  {
    constexpr static char const * regionString() { return "VTKRegion"; }
  };
 
  void importVolumicFieldOnArray( string const & cellBlockName,
                                  string const & meshFieldName,
                                  bool isMaterialField,
                                  dataRepository::WrapperBase & wrapper ) const;
 
  void importSurfacicFieldOnArray( string const & faceBlockName,
                                   string const & meshFieldName,
                                   dataRepository::WrapperBase & wrapper ) const;
 
  // TODO can we use unique_ptr to hold mesh?
  vtkSmartPointer< vtkDataSet > m_vtkMesh;
 
  string m_regionAttributeName;
 
  string m_structuredIndexAttributeName;
 
  string m_mainBlockName;
 
  string_array m_faceBlockNames;
 
  stdMap< string, vtkSmartPointer< vtkDataSet > > m_faceBlockMeshes;
 
  string_array m_nodesetNames;
 
  integer m_partitionRefinement = 0;
 
  integer m_useGlobalIds = 0;
 
  vtk::PartitionMethod m_partitionMethod = vtk::PartitionMethod::parmetis;
 
  vtk::CellMapType m_cellMap;
 
  string m_dataSourceName;
 
  VTKHierarchicalDataSource * m_dataSource;
 
};
 
} // namespace geos
 
#endif /* GEOS_MESH_GENERATORS_VTKMESHGENERATOR_HPP */