LineBlock.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_WELLBLOCK_HPP
#define GEOS_WELLBLOCK_HPP
 
#include "mesh/generators/LineBlockABC.hpp"
 
 
namespace geos
{
 
class LineBlock : public LineBlockABC
{
public:
  LineBlock( string const & name, Group * const parent );
 
 
  // getters for element data
 
  globalIndex numElements() const override final { return m_numElems; }
 
  void setNumElements( globalIndex numElems )  { m_numElems = numElems; }
 
  arrayView2d< real64 const > getElemCoords() const override final { return m_elemCenterCoords; }
 
  void setElemCoords( arrayView2d< real64 const > elemCenterCoords )  { m_elemCenterCoords = elemCenterCoords; }
 
  arrayView1d< globalIndex const > getNextElemIndex() const override final { return m_nextElemId; }
 
  void setNextElemIndex( arrayView1d< globalIndex const > nextElemId )  { m_nextElemId = nextElemId; }
 
  arrayView1d< arrayView1d< globalIndex const > const > getPrevElemIndices() const override final { return m_prevElemId.toNestedViewConst(); }
 
 
  void setPrevElemIndices( arrayView1d< arrayView1d< globalIndex const > const > prevElemIndices );
 
  arrayView2d< globalIndex const > getElemToNodesMap() const override final { return m_elemToNodesMap; }
 
 
  void setElemToNodesMap( arrayView2d< globalIndex const > elemToNodesMap ) { m_elemToNodesMap = elemToNodesMap; }
 
  arrayView1d< real64 const > getElemVolume() const override final { return m_elemVolume; }
 
 
  void setElemVolume( arrayView1d< real64 const > elemVolume ) { m_elemVolume = elemVolume; }
 
  real64 getElementRadius() const override final { return m_radius; }
 
 
  void setElementRadius( real64 radius ) { m_radius = radius; }
 
  // getters for node data
 
  globalIndex numNodes() const override final { return m_numNodes; }
 
 
  void setNumNodes( globalIndex numNodes ) { m_numNodes = numNodes; }
 
  arrayView2d< real64 const > getNodeCoords() const override final { return m_nodeCoords; }
 
  void setNodeCoords( arrayView2d< real64 const > nodeCoords ) { m_nodeCoords = nodeCoords; }
 
 
 
  // getters for perforation data
 
  globalIndex numPerforations() const override final { return m_numPerforations; }
 
 
  void setNumPerforations( globalIndex numPerforations ) { m_numPerforations = numPerforations; }
 
  arrayView2d< real64 const > getPerfCoords() const override final { return m_perfCoords; }
 
 
  void setPerfCoords( arrayView2d< real64 const > perfCoords ) { m_perfCoords = perfCoords; }
 
  arrayView1d< real64 const > getPerfTransmissibility() const override final { return m_perfTransmissibility; }
 
 
  void setPerfTransmissibility( arrayView1d< real64 const > perfTransmissibility ) { m_perfTransmissibility = perfTransmissibility; }
 
  arrayView1d< real64 const > getPerfSkinFactor() const override final { return m_perfSkinFactor; }
 
  string_array const & getPerfTargetRegion() const override final { return m_perfTargetRegion; }
 
  void setPerfSkinFactor( arrayView1d< real64 const > perfSkinFactor ) { m_perfSkinFactor = perfSkinFactor; }
 
  void setPerfTargetRegion( string_array const & perfTargetRegion ) { m_perfTargetRegion = perfTargetRegion; }
 
  arrayView1d< globalIndex const > getPerfElemIndex() const override final { return m_perfElemId; }
 
  void setPerfElemIndex( arrayView1d< globalIndex const > perfElemId ) { m_perfElemId = perfElemId; }
 
  void setWellControlsName( string const & wellControlsName ) { m_wellControlsName = wellControlsName; }
  string const & getWellControlsName( ) const override final { return m_wellControlsName; }
 
  void setWellGeneratorName( string const & wellGeneratorName ) { m_wellGeneratorName = wellGeneratorName; }
  string const & getWellGeneratorName( ) const override final { return m_wellGeneratorName; }
 
 
 
 
 
private:
 
 
  // XML Input
 
  real64 m_radius;
 
  // Geometry of the well (later passed to the WellElementSubRegion)
 
  // well element data
 
  globalIndex m_numElems;
 
  array2d< real64 > m_elemCenterCoords;
 
  array1d< globalIndex > m_nextElemId;
 
  array1d< array1d< globalIndex > > m_prevElemId;
 
  array2d< globalIndex > m_elemToNodesMap;
 
  array1d< real64 > m_elemVolume;
 
 
  // well node data
 
  globalIndex m_numNodes;
 
  array2d< real64 > m_nodeCoords;
 
  // perforation data
 
  globalIndex m_numPerforations;
 
  array2d< real64 > m_perfCoords;
 
  array1d< real64 > m_perfTransmissibility;
 
  array1d< real64 > m_perfSkinFactor;
 
  string_array m_perfTargetRegion;
 
  array1d< globalIndex > m_perfElemId;
 
 
 
  // Perforation data
 
  string_array m_perforationList;
 
  string m_wellControlsName;
 
  string m_wellGeneratorName;
 
};
}
#endif