SurfaceElementSubRegion.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_SURFACEELEMENTSUBREGION_HPP_
#define GEOSX_MESH_SURFACEELEMENTSUBREGION_HPP_

#include "ElementSubRegionBase.hpp"
#include "InterObjectRelation.hpp"
#include "ToElementRelation.hpp"
#include "EdgeManager.hpp"
#include "CellElementSubRegion.hpp"

namespace geosx
{

class SurfaceElementSubRegion : public ElementSubRegionBase
{
public:

  using NodeMapType = InterObjectRelation< ArrayOfArrays< localIndex > >;

  using EdgeMapType = InterObjectRelation< ArrayOfArrays< localIndex > >;


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

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



  SurfaceElementSubRegion( string const & name,
                           dataRepository::Group * const parent );


  virtual ~SurfaceElementSubRegion() override;



  NodeMapType const & nodeList() const
  {
    return m_toNodesRelation;
  }

  NodeMapType & nodeList()
  {
    return m_toNodesRelation;
  }

  localIndex & nodeList( localIndex const k, localIndex a ) { return m_toNodesRelation( k, a ); }

  localIndex const & nodeList( localIndex const k, localIndex a ) const { return m_toNodesRelation( k, a ); }

  EdgeMapType const & edgeList() const
  {
    return m_toEdgesRelation;
  }

  EdgeMapType & edgeList()
  {
    return m_toEdgesRelation;
  }

  FixedToManyElementRelation & getToCellRelation()
  {
    return m_surfaceElementsToCells;
  }

  FixedToManyElementRelation const & getToCellRelation() const
  {
    return m_surfaceElementsToCells;
  }




  arrayView1d< real64 > getElementAperture() { return m_elementAperture; }

  arrayView1d< real64 const > getElementAperture() const { return m_elementAperture; }

  arrayView1d< real64 > getElementArea() { return m_elementArea; }

  arrayView1d< real64 const > getElementArea() const { return m_elementArea; }


  struct viewKeyStruct : ElementSubRegionBase::viewKeyStruct
  {
    static constexpr auto surfaceElementsToCellRegionsString    = "fractureElementsToCellRegions";

    static constexpr auto surfaceElementsToCellSubRegionsString    = "fractureElementsToCellSubRegions";

    static constexpr auto surfaceElementsToCellIndexString    = "fractureElementsToCellIndices";


    static constexpr auto elementApertureString        = "elementAperture";

    static constexpr auto elementAreaString            = "elementArea";

    constexpr static auto creationMassString = "creationMass";

  };

  FixedToManyElementRelation m_surfaceElementsToCells;

protected:

  NodeMapType m_toNodesRelation;

  EdgeMapType m_toEdgesRelation;

  array1d< real64 > m_elementAperture;

  array1d< real64 > m_elementArea;

};

} /* namespace geosx */

#endif /* SRC_CORECOMPONENTS_MESH_SURFACEELEMENTSUBREGION_HPP_ */