WellElementRegion.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * 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_MESH_WELLELEMENTREGION_HPP_
#define GEOS_MESH_WELLELEMENTREGION_HPP_
 
#include "mesh/ElementRegionBase.hpp"
#include "mesh/generators/LineBlockABC.hpp"
 
namespace geos
{
 
class MeshLevel;
 
class WellElementRegion : public ElementRegionBase
{
public:
 
 
  WellElementRegion( string const & name, Group * const parent );
 
  virtual ~WellElementRegion() override;
 
  WellElementRegion() = delete;
 
 
 
  static string catalogName()
  { return "WellElementRegion"; }
 
  virtual string getCatalogName() const override final
  { return catalogName(); }
 
 
 
  void setWellGeneratorName( string const & name ) { m_wellGeneratorName = name; }
 
  string const & getWellGeneratorName() const { return m_wellGeneratorName; }
 
  void setWellControlsName( string const & name ) { m_wellControlsName = name; }
 
  string const & getSubRegionName() const { return m_subRegionName; }
 
 
 
  void generateMesh( Group const & ) override {}
 
  void generateWell( MeshLevel & mesh,
                     LineBlockABC const & lineBlock,
                     globalIndex nodeOffsetGlobal,
                     globalIndex elemOffsetGlobal,
                     real64 globalLength );
 
 
  struct viewKeyStruct : public ElementRegionBase::viewKeyStruct
  {
    static constexpr char const * wellControlsString() { return "wellControlsName"; }
    static constexpr char const * wellGeneratorString() { return "wellGeneratorName"; }
 
    dataRepository::ViewKey wellControlsName  = { wellControlsString() };
    dataRepository::ViewKey wellGeneratorName = { wellGeneratorString() };
  }
  viewKeysWellElementRegion;
 
private:
 
  const string m_subRegionName;
 
  string m_wellControlsName;
 
  string m_wellGeneratorName;
 
};
 
} /* namespace geos */
 
#endif /* GEOS_MESH_WELLELEMENTREGION_HPP_ */