Perforation.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 Perforation.hpp
 */
 
#ifndef GEOS_MESH_PERFORATION_HPP
#define GEOS_MESH_PERFORATION_HPP
 
#include "dataRepository/Group.hpp"
 
namespace geos
{
 
class Perforation : public dataRepository::Group
{
public:
 
  explicit Perforation( string const & name, dataRepository::Group * const parent );
 
  ~Perforation() override;
 
  Perforation() = delete;
 
  Perforation( Perforation const & ) = delete;
 
  Perforation( Perforation && ) = delete;
 
  Perforation & operator=( Perforation const & ) = delete;
 
  Perforation & operator=( Perforation && ) = delete;
 
 
 
  real64 const & getDistanceFromWellHead() const { return m_distanceFromHead; }
 
  real64 getWellTransmissibility() const { return m_wellTransmissibility; }
 
  real64 getWellSkinFactor() const { return m_wellSkinFactor; }
 
  string const & getTargetRegion() const { return m_targetRegionName; }
 
 
  struct viewKeyStruct
  {
    static constexpr char const *distanceFromHeadString() { return "distanceFromHead"; }
    static constexpr char const *wellTransmissibilityString() { return "transmissibility"; }
    static constexpr char const *wellSkinFactorString() { return "skinFactor"; }
    static constexpr char const *targetRegionString() { return "targetRegion"; }
  }
  viewKeysPerforation;
 
protected:
  void postInputInitialization() override;
 
private:
  real64 m_distanceFromHead;
 
  real64 m_wellTransmissibility;
 
  real64 m_wellSkinFactor;
 
  string m_targetRegionName;
};
 
} // namespace geos
 
#endif // GEOS_MESH_PERFORATION_HPP