Perforation.hpp

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2020 Total, S.A
 * Copyright (c) 2019-     GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */

/*
 * @file Perforation.hpp
 */

#ifndef GEOSX_MESHUTILITIES_PERFORATION_HPP
#define GEOSX_MESHUTILITIES_PERFORATION_HPP

#include "dataRepository/Group.hpp"

namespace geosx
{

namespace dataRepository
{
namespace keys
{
static constexpr auto perforation = "Perforation";
}
}


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; }


  struct viewKeyStruct
  {
    static constexpr auto distanceFromHeadString  = "distanceFromHead";
    static constexpr auto wellTransmissibilityString = "transmissibility";
    dataRepository::ViewKey distanceFromHead  = { distanceFromHeadString };
    dataRepository::ViewKey wellTransmissibility = { wellTransmissibilityString };
  }
  viewKeysPerforation;

protected:

  void PostProcessInput() override;

private:

  real64 m_distanceFromHead;

  real64 m_wellTransmissibility;

};

} //namespace geosx

#endif //GEOSX_MESHUTILITIES_PERFORATION_HPP