FaceElementSubRegion.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_FACEELEMENTSUBREGION_HPP_
#define GEOSX_MESH_FACEELEMENTSUBREGION_HPP_

#include "SurfaceElementSubRegion.hpp"

namespace geosx
{

class FaceElementSubRegion : public SurfaceElementSubRegion
{
public:

  using FaceMapType = InterObjectRelation< array2d< localIndex > >;


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

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



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


  virtual ~FaceElementSubRegion() override;



  virtual void CalculateElementGeometricQuantities( NodeManager const & nodeManager,
                                                    FaceManager const & faceManager ) override;
  void CalculateElementGeometricQuantities( localIndex const index,
                                            arrayView1d< real64 const > const & faceArea );

  virtual localIndex PackUpDownMapsSize( arrayView1d< localIndex const > const & packList ) const override;

  virtual localIndex PackUpDownMaps( buffer_unit_type * & buffer,
                                     arrayView1d< localIndex const > const & packList ) const override;

  virtual localIndex UnpackUpDownMaps( buffer_unit_type const * & buffer,
                                       array1d< localIndex > & packList,
                                       bool const overwriteUpMaps,
                                       bool const overwriteDownMaps ) override;

  virtual void FixUpDownMaps( bool const clearIfUnmapped ) override;

  virtual void ViewPackingExclusionList( SortedArray< localIndex > & exclusionList ) const override;


  void inheritGhostRankFromParentFace( FaceManager const * const faceManager,
                                       std::set< localIndex > const & indices );

  struct viewKeyStruct : SurfaceElementSubRegion::viewKeyStruct
  {
    static constexpr auto dNdXString = "dNdX";

    static constexpr auto detJString = "detJ";

#if GEOSX_USE_SEPARATION_COEFFICIENT

    constexpr static auto separationCoeffString = "separationCoeff";

    constexpr static auto dSeparationCoeffdAperString = "dSeparationCoeffdAper";
#endif

  };

  virtual void setupRelatedObjectsInRelations( MeshLevel const * const mesh ) override;



  FaceMapType const & faceList() const
  {
    return m_toFacesRelation;
  }

  FaceMapType & faceList()
  {
    return m_toFacesRelation;
  }



  //virtual localIndex numNodesPerElement( localIndex const k ) const override { return m_toNodesRelation[k].size(); }

#ifdef GEOSX_USE_SEPARATION_COEFFICIENT

  arrayView1d< real64 > getSeparationCoefficient() { return m_separationCoefficient; }
  arrayView1d< real64 const > getSeparationCoefficient() const { return m_separationCoefficient; }
#endif


  map< localIndex, array1d< globalIndex > > m_unmappedGlobalIndicesInToNodes;

  map< localIndex, array1d< globalIndex > > m_unmappedGlobalIndicesInToEdges;

  map< localIndex, array1d< globalIndex > > m_unmappedGlobalIndicesInToFaces;

  SortedArray< localIndex > m_newFaceElements;

  array4d< real64 > & dNdX()
  { return m_dNdX; }

  arrayView4d< real64 const > dNdX() const
  { return m_dNdX.toViewConst(); }

  array2d< real64 > & detJ()
  { return m_detJ; }

  arrayView2d< real64 const > detJ() const
  { return m_detJ; }

private:

  template< bool DOPACK >
  localIndex PackUpDownMapsPrivate( buffer_unit_type * & buffer,
                                    arrayView1d< localIndex const > const & packList ) const;

  array4d< real64 > m_dNdX;

  array2d< real64 > m_detJ;

  FaceMapType m_toFacesRelation;

#ifdef GEOSX_USE_SEPARATION_COEFFICIENT
  array1d< real64 > m_separationCoefficient;
#endif

};

} /* namespace geosx */

#endif /* GEOSX_MESH_FACEELEMENTSUBREGION_HPP_ */