WellElementRegion.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * 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.
 * ------------------------------------------------------------------------------------------------------------
 */

#ifndef GEOSX_MESH_WELLELEMENTREGION_HPP_
#define GEOSX_MESH_WELLELEMENTREGION_HPP_

#include "mesh/ElementRegionBase.hpp"
#include "meshUtilities/InternalWellGenerator.hpp"

namespace geosx
{

class MeshLevel;

class WellElementRegion : public ElementRegionBase
{
public:


  WellElementRegion( string const & name, Group * const parent );

  virtual ~WellElementRegion() override;

  WellElementRegion() = delete;



  static const string CatalogName()
  { return "WellElementRegion"; }

  virtual const string getCatalogName() const override final
  { return WellElementRegion::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; }



  virtual void GenerateMesh( Group * ) override {}

  void GenerateWell( MeshLevel & mesh,
                     InternalWellGenerator const & wellGeometry,
                     globalIndex nodeOffsetGlobal,
                     globalIndex elemOffsetGlobal );


  struct viewKeyStruct : public ElementRegionBase::viewKeyStruct
  {
    static constexpr auto wellControlsString  = "wellControlsName";
    static constexpr auto wellGeneratorString = "wellGeneratorName";

    dataRepository::ViewKey wellControlsName  = { wellControlsString };
    dataRepository::ViewKey wellGeneratorName = { wellGeneratorString };

  }
  viewKeysWellElementRegion;

  struct groupKeyStruct : public ElementRegionBase::groupKeyStruct
  {}
  groupKeysWellElementRegion;

private:

  const string m_subRegionName;

  string m_wellControlsName;

  string m_wellGeneratorName;

};

} /* namespace geosx */

#endif /* GEOSX_MESH_WELLELEMENTREGION_HPP_ */