PerforationData.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.
 * ------------------------------------------------------------------------------------------------------------
 */
 
/*
 * @file PerforationData.hpp
 */
 
#ifndef GEOS_MESH_PERFORATIONDATA_HPP
#define GEOS_MESH_PERFORATIONDATA_HPP
 
#include "dataRepository/Group.hpp"
#include "mesh/ObjectManagerBase.hpp"
#include "mesh/ToElementRelation.hpp"
#include "mesh/generators/LineBlockABC.hpp"
#include "functions/TableFunction.hpp"
namespace geos
{
 
class DomainPartition;
class MeshLevel;
class WellElementSubRegion;
 
class PerforationData : public ObjectManagerBase
{
public:
 
  enum PerforationStatus : unsigned
  {
    CLOSED = 0,            //  no flow in element
    OPEN = 1
  };
 
 
  explicit PerforationData( string const & name, dataRepository::Group * const parent );
 
  ~PerforationData() override;
 
  PerforationData() = delete;
 
  PerforationData( PerforationData const & ) = delete;
 
  PerforationData( PerforationData && ) = delete;
 
  PerforationData & operator=( PerforationData const & ) = delete;
 
  PerforationData & operator=( PerforationData && ) = delete;
 
 
 
  static string catalogName() { return "PerforationData"; }
 
  virtual string getCatalogName() const override { return catalogName(); }
 
 
 
  void setNumPerforationsGlobal( globalIndex nPerfs ) { m_numPerforationsGlobal = nPerfs; }
 
 
  globalIndex getNumPerforationsGlobal() const { return m_numPerforationsGlobal; }
 
 
  ToElementRelation< array1d< localIndex > > & getMeshElements() { return m_toMeshElements; }
 
 
  ToElementRelation< array1d< localIndex > > const & getMeshElements() const { return m_toMeshElements; }
 
  arrayView1d< localIndex > getWellElements() { return m_wellElementIndex; }
 
  array1d< bool > & isReservoirElementFound() { return m_isReservoirElementFound; }
 
  arrayView1d< bool const > isReservoirElementFound() const { return m_isReservoirElementFound; }
 
  bool hasLocalPerforationInReservoir( localIndex perfoLocalIndex ) const
  { return m_isReservoirElementFound[perfoLocalIndex]; }
 
  arrayView1d< localIndex const > getWellElements() const { return m_wellElementIndex; }
 
  arrayView1d< globalIndex > getReservoirElementGlobalIndex() { return m_reservoirElementGlobalIndex; }
 
 
 
  arrayView1d< globalIndex const > getReservoirElementGlobalIndex() const { return m_reservoirElementGlobalIndex; }
 
 
  arrayView2d< real64 > getLocation() { return m_location; }
 
 
  arrayView2d< real64 const > getLocation() const { return m_location; }
 
 
  arrayView1d< real64 const > getWellTransmissibility() const { return m_wellTransmissibility; }
 
 
  arrayView1d< real64 > getWellTransmissibility() { return m_wellTransmissibility; }
 
 
  arrayView1d< real64 const > getWellSkinFactor() const { return m_wellSkinFactor; }
 
 
  arrayView1d< real64 > getWellSkinFactor() { return m_wellSkinFactor; }
 
 
  string_array & getPerfName() { return m_perfName; }
 
  string_array const & getPerfName() const { return m_perfName; }
 
  string_array & getPerfStatusTableName() { return m_perfStatusTableName; }
 
  string_array const & getPerfStatusTableName() const { return m_perfStatusTableName; }
 
  arrayView1d< localIndex const > getLocalPerfStatus() const { return m_localPerfStatus; }
 
 
  arrayView1d< localIndex > getLocalPerfStatus() { return m_localPerfStatus; }
 
 
 
  void computeWellTransmissibility( MeshLevel const & mesh,
                                    WellElementSubRegion const & wellElemSubRegion,
                                    array1d< array1d< arrayView3d< real64 const > > > const & perm );
 
 
 
  void connectToWellElements( LineBlockABC const & lineBlock,
                              unordered_map< globalIndex, localIndex > const & globalToLocalWellElementMap,
                              globalIndex elemOffsetGlobal );
 
 
  struct viewKeyStruct : public ObjectManagerBase::viewKeyStruct
  {
    static constexpr char const * numPerforationsGlobalString() { return "numPerforationsGlobal"; }
    static constexpr char const * perforationStatusTableName() { return "perforationStatusTableName"; }
    static constexpr char const * perforationName() { return "perforationName"; }
  }
  viewKeysPerforationData;
 
private:
 
 
  void getReservoirElementDimensions( MeshLevel const & mesh,
                                      localIndex const er, localIndex const esr, localIndex const ei,
                                      real64 & dx, real64 & dy, real64 & dz ) const;
 
 
 
  globalIndex m_numPerforationsGlobal;
 
  ToElementRelation< array1d< localIndex > > m_toMeshElements;
 
  array1d< localIndex > m_wellElementIndex;
 
  array1d< globalIndex > m_reservoirElementGlobalIndex;
 
  array1d< bool > m_isReservoirElementFound;
 
  array2d< real64 > m_location;
 
  array1d< real64 > m_wellTransmissibility;
 
  array1d< real64 > m_wellSkinFactor;
 
  string_array m_perfName;
 
  string_array m_perfStatusTableName;
 
  array1d< localIndex > m_localPerfStatus;
 
};
 
} //namespace geos
 
#endif //GEOS_MESH_PERFORATIONDATA_HPP