CellBlockManagerABC.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_CELLBLOCKMANAGERABC_HPP
#define GEOS_CELLBLOCKMANAGERABC_HPP
 
#include "CellBlockUtilities.hpp"
#include "dataRepository/Group.hpp"
#include "LineBlockABC.hpp"
 
#include <map>
 
namespace geos
{
 
class CellBlockManagerABC : public dataRepository::Group
{
public:
 
  CellBlockManagerABC( string const & name, Group * const parent ):
    Group( name, parent )
  {
    // Left blank
  }
 
  static constexpr localIndex edgeMapExtraSpacePerNode()
  { return 8; }
 
  static constexpr localIndex faceMapExtraSpacePerNode()
  { return 8; }
 
  static constexpr localIndex elemMapExtraSpacePerNode()
  { return 8; }
 
  static constexpr localIndex nodeMapExtraSpacePerFace()
  { return 4; }
 
  static constexpr localIndex edgeMapExtraSpacePerFace()
  { return 4; }
 
  static constexpr localIndex faceMapExtraSpacePerEdge()
  { return 4; }
 
  virtual Group & getCellBlocks() = 0;
 
  virtual Group & getFaceBlocks() = 0;
 
  virtual LineBlockABC const & getLineBlock( string name ) const = 0;
 
  virtual Group const & getCellBlocks() const = 0;
 
  virtual Group const & getFaceBlocks() const = 0;
 
  virtual std::map< integer, std::set< string > > const & getRegionAttributesCellBlocks() const = 0;
 
  virtual localIndex numNodes() const = 0;
 
  virtual localIndex numEdges() const = 0;
 
  virtual localIndex numFaces() const = 0;
 
  virtual array2d< real64, nodes::REFERENCE_POSITION_PERM > getNodePositions() const = 0;
 
  virtual ArrayOfArrays< localIndex > getNodeToEdges() const = 0;
 
  virtual ArrayOfArrays< localIndex > getNodeToFaces() const = 0;
 
  virtual ToCellRelation< ArrayOfArrays< localIndex > > getNodeToElements() const = 0;
  virtual array2d< localIndex > getEdgeToNodes() const = 0;
 
  virtual ArrayOfArrays< localIndex > getEdgeToFaces() const = 0;
 
  virtual ArrayOfArrays< localIndex > getFaceToNodes() const = 0;
 
  virtual ArrayOfArrays< localIndex > getFaceToEdges() const = 0;
 
  virtual ToCellRelation< array2d< localIndex > > getFaceToElements() const = 0;
 
  virtual array1d< globalIndex > getNodeLocalToGlobal() const = 0;
 
  virtual std::map< string, SortedArray< localIndex > > const & getNodeSets() const = 0;
 
  virtual real64 getGlobalLength() const = 0;
 
  virtual void generateHighOrderMaps( localIndex const order,
                                      globalIndex const maxVertexGlobalID,
                                      globalIndex const maxEdgeGlobalID, globalIndex const maxFaceGlobalID,
                                      arrayView1d< globalIndex const > const edgeLocalToGlobal,
                                      arrayView1d< globalIndex const > const faceLocalToGlobal ) = 0;
 
};
 
}
#endif // include guard