WellGeneratorABC.hpp

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 Total, S.A
 * 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 WellGeneratorABC.hpp
 *
 */
 
#ifndef GEOS_MESH_GENERATORS_WELLGENERATORABC_HPP_
#define GEOS_MESH_GENERATORS_WELLGENERATORABC_HPP_
 
#include "dataRepository/Group.hpp"
#include "codingUtilities/Utilities.hpp"
#include "common/DataTypes.hpp"
 
 
namespace geos
{
 
class WellGeneratorABC : public dataRepository::Group
{
public:
 
  WellGeneratorABC( const string & name,
                    Group * const parent )
    :
    Group( name, parent )
  { }
 
  virtual void generateWellGeometry( ) = 0;
 
 
  // getters for element data
 
  virtual globalIndex numElements() const = 0;
 
  virtual const array2d< globalIndex > & getSegmentToPolyNodeMap() const = 0;
 
  virtual globalIndex numNodesPerElement() const = 0;
 
  virtual const array2d< real64 > & getPolyNodeCoord() const = 0;
 
  virtual real64 getMinSegmentLength() const = 0;
 
  virtual real64 getMinElemLength() const = 0;
 
  virtual const string_array & getPerforationList() const = 0;
 
  virtual arrayView2d< real64 const > getElemCoords() const = 0;
 
  virtual arrayView1d< globalIndex const > getNextElemIndex() const = 0;
 
  virtual arrayView1d< arrayView1d< globalIndex const > const > getPrevElemIndices() const = 0;
 
  virtual arrayView2d< globalIndex const > getElemToNodesMap() const = 0;
 
  virtual arrayView1d< real64 const > getElemVolume() const = 0;
 
  virtual real64 getElementRadius() const = 0;
 
  // getters for node data
 
  virtual globalIndex numNodes() const = 0;
 
  virtual arrayView2d< real64 const > getNodeCoords() const = 0;
 
 
 
  // getters for perforation data
  virtual globalIndex numPerforations() const = 0;
 
  virtual arrayView2d< real64 const > getPerfCoords() const = 0;
 
  virtual arrayView1d< real64 const > getPerfTransmissibility() const = 0;
 
  virtual arrayView1d< real64 const > getPerfSkinFactor() const = 0;
 
  virtual arrayView1d< globalIndex const > getPerfElemIndex() const = 0;
 
  virtual int getPhysicalDimensionsNumber() const = 0;
 
  virtual const string getWellRegionName() const = 0;
 
  virtual const string getWellControlsName() const = 0;
};
}
#endif /* GEOS_MESH_GENERATORS_WELLGENERATORABC_HPP_ */