LineBlockABC.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_WELLBLOCKABC_HPP
#define GEOS_WELLBLOCKABC_HPP
 
#include "dataRepository/Group.hpp"
#include "common/DataTypes.hpp"
 
#include <vector>
 
namespace geos
{
 
class LineBlockABC : public dataRepository::Group
{
public:
 
  struct NodeLocation
  {
    static constexpr integer TOP    = 0; 
    static constexpr integer BOTTOM = 1; 
  };
 
  LineBlockABC( string const & name,
                Group * const parent )
    :
    Group( name, parent )
  { }
 
 
  // getters for element data
 
  virtual globalIndex numElements() 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 string_array const & getPerfTargetRegion() const = 0;
 
  virtual string_array const & getPerfName() const = 0;
 
  virtual string_array const & getPerfStatusTableName() const = 0;
 
  virtual arrayView1d< globalIndex const > getPerfElemIndex() const = 0;
 
  virtual string const & getWellControlsName() const = 0;
 
  virtual string const & getWellGeneratorName() const = 0;
};
 
}
 
#endif //GEOS_WELLBLOCKABC_HPP