SurfaceElementRegion.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_SURFACEELEMENTREGION_HPP_
#define GEOSX_MESH_SURFACEELEMENTREGION_HPP_

#include "ElementRegionBase.hpp"
#include "common/EnumStrings.hpp"

namespace geosx
{


class EdgeManager;

class SurfaceElementRegion : public ElementRegionBase
{
public:

  enum class SurfaceSubRegionType : integer
  {
    faceElement,
    embeddedElement
  };


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

  SurfaceElementRegion() = delete;

  virtual ~SurfaceElementRegion() override;



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

  virtual const string getCatalogName() const override final
  { return SurfaceElementRegion::CatalogName(); }




  virtual void GenerateMesh( Group * ) override;

  localIndex AddToFractureMesh( real64 const time_np1,
                                EdgeManager * const edgeManager,
                                FaceManager const * const faceManager,
                                ArrayOfArraysView< localIndex const > const & originalFaceToEdges,
                                string const & subRegionName,
                                localIndex const faceIndices[2] );




  real64 getDefaultAperture() const { return m_defaultAperture; }

  SurfaceSubRegionType subRegionType() const { return m_subRegionType; }



  struct viewKeyStruct : public ElementRegionBase::viewKeyStruct
  {
    static constexpr auto subRegionTypeString = "subRegionType";

    static constexpr auto fractureSetString = "fractureSet";
    static constexpr auto defaultApertureString = "defaultAperture";
    static constexpr auto ruptureTimeString = "ruptureTime";
  };

protected:
  virtual void InitializePreSubGroups( Group * const ) override;

private:

  SurfaceSubRegionType m_subRegionType;

  real64 m_defaultAperture;

};

ENUM_STRINGS( SurfaceElementRegion::SurfaceSubRegionType, "faceElement", "embeddedElement" )

} /* namespace geosx */

#endif /* CORECOMPONENTS_MESH_SurfaceElementRegion_HPP_ */