CollocatedNodes.hpp

/*
 * ------------------------------------------------------------------------------------------------------------
 * 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_COLLOCATEDNODES_HPP
#define GEOS_COLLOCATEDNODES_HPP

#include "common/DataTypes.hpp"

#include <vtkDataSet.h>
#include <vtkIdTypeArray.h>
#include <vtkSmartPointer.h>

namespace geos::vtk
{

/**
 * @brief Convenience wrapper around the raw vtk information.
 */
class CollocatedNodes
{
public:
  /**
   * @brief Build a convenience wrapper around the raw vtk collocated nodes information.
   * @param faceBlockName The face block name.
   * @param faceMesh The face mesh for which the collocated nodes structure will be fed.
   * @param performGlobalCheck Whether to check across all MPI ranks if field is missing (default: true).
   *        Set to false when only calling on a subset of ranks.
   */
  CollocatedNodes( string const & faceBlockName,
                   vtkSmartPointer< vtkDataSet > faceMesh,
                   bool performGlobalCheck = true );

  /**
   * @brief For node @p i of the face block, returns all the duplicated global node indices in the main 3d mesh.
   * @param i the node in the face block (numbering is local to the face block).
   * @return The list of global node indices in the main 3d mesh.
   */
  stdVector< vtkIdType > const & operator[]( std::size_t i ) const
  {
    return m_collocatedNodes[i];
  }

  /**
   * @brief Number of duplicated nodes buckets.
   * Multiple nodes that are considered to be duplicated one of each other make one bucket.
   * @return The number of duplicated nodes buckets.
   */
  [[nodiscard]] std::size_t size() const
  {
    return m_collocatedNodes.size();
  }

private:

  /**
   * @brief Populates the mapping.
   * @param collocatedNodes The pointer to the vtk data array. Guaranteed not to be null.
   * @details Converts the raw vtk data to STL containers.
   */
  void init( vtkIdTypeArray const * collocatedNodes );

  /// For each node of the face block, lists all the collocated nodes in the main 3d mesh.
  stdVector< stdVector< vtkIdType > > m_collocatedNodes;
};

} // geos::vtk

#endif //GEOS_COLLOCATEDNODES_HPP