InternalWellboreGenerator.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_MESHUTILITIES_INTERNALWELLBOREGENERATOR_HPP
#define GEOS_MESHUTILITIES_INTERNALWELLBOREGENERATOR_HPP
 
#include "common/format/EnumStrings.hpp"
#include "dataRepository/Group.hpp"
#include "InternalMeshGenerator.hpp"
 
namespace geos
{
 
class InternalWellboreGenerator : public InternalMeshGenerator
{
public:
 
  InternalWellboreGenerator( string const & name, Group * const parent );
 
  ~InternalWellboreGenerator() override = default;
 
  static string catalogName() { return "InternalWellbore"; }
 
protected:
 
  void reduceNumNodesForPeriodicBoundary( SpatialPartition & partition,
                                          integer ( &numNodes )[3] ) override final;
 
  void setNodeGlobalIndicesOnPeriodicBoundary( SpatialPartition & partition,
                                               int ( & index )[3] ) override final;
 
  void setConnectivityForPeriodicBoundaries( int ( & globalIJK )[3],
                                             integer const ( &numNodesInDir )[3],
                                             int const ( &firstElemIndexInPartition )[3],
                                             localIndex ( &nodeOfBox )[8] ) override final;
 
  void coordinateTransformation( arrayView2d< real64, nodes::REFERENCE_POSITION_USD > X,
                                 stdMap< string, SortedArray< localIndex > > & nodeSets ) override final;
 
  inline bool isCartesian() const override final
  {
    return false;
  }
 
  struct viewKeyStruct : public InternalMeshGenerator::viewKeyStruct
  {
    constexpr static char const * radiusString() { return "radius"; }
    constexpr static char const * thetaString() { return "theta"; }
    constexpr static char const * rOutString() { return "rOut"; }
    constexpr static char const * rElemsString() { return "nr"; }
    constexpr static char const * tElemsString() { return "nt"; }
    constexpr static char const * rBiasString() { return "rBias"; }
    constexpr static char const * trajectoryString() { return "trajectory"; }
    constexpr static char const * cartesianOuterBoundaryString() { return "useCartesianOuterBoundary"; }
    constexpr static char const * cartesianMappingInnerRadiusString() { return "cartesianMappingInnerRadius"; }
    constexpr static char const * autoSpaceRadialElemsString() { return "autoSpaceRadialElems"; }
    constexpr static char const * hardRadialCoordsString() { return "hardRadialCoords"; }
 
  };
 
  void postInputInitialization() override final;
 
private:
 
  array2d< real64 > m_trajectory;
 
  int m_cartesianOuterBoundary;
 
  real64 m_cartesianMappingInnerRadius;
 
  bool m_isFullAnnulus;
 
  array1d< real64 > m_autoSpaceRadialElems;
 
  array1d< real64 > & m_radialCoords;
 
};
 
} /* namespace geos */
 
#endif /* GEOS_MESHUTILITIES_INTERNALWELLBOREGENERATOR_HPP */