AggregateElementSubRegion.hpp

/*
 * ------------------------------------------------------------------------------------------------------------
 * 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_AGGREGATEELEMENTSUBREGION_HPP_
#define GEOSX_MESH_AGGREGATEELEMENTSUBREGION_HPP_

#include "ElementSubRegionBase.hpp"
#include "InterObjectRelation.hpp"



namespace geosx
{


class AggregateElementSubRegion : public ElementSubRegionBase
{
public:

  using NodeMapType=FixedOneToManyRelation;


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

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

  template< typename LAMBDA >
  void forFineCellsInAggregate( localIndex aggregateIndex, LAMBDA lambda )
  {
    for( localIndex fineCell = m_nbFineCellsPerCoarseCell[aggregateIndex];
         fineCell < m_nbFineCellsPerCoarseCell[aggregateIndex+1]; fineCell++ )
    {
      lambda( m_fineToCoarse[fineCell] );
    }
  }


  localIndex GetNbCellsPerAggregate( localIndex aggregateIndex ) const
  {
    return m_nbFineCellsPerCoarseCell[aggregateIndex + 1] - m_nbFineCellsPerCoarseCell[aggregateIndex];
  }


  AggregateElementSubRegion( string const & name,
                             dataRepository::Group * const parent );
  virtual ~AggregateElementSubRegion() override;

  void CreateFromFineToCoarseMap( localIndex nbAggregates,
                                  arrayView1d< localIndex const > const & fineToCoarse,
                                  arrayView2d< real64 const > const & barycenters );

  const array1d< localIndex > & GetFineToCoarseMap()
  {
    return m_fineToCoarse;
  }

  virtual void CalculateElementGeometricQuantities( NodeManager const & nodeManager,
                                                    FaceManager const & faceManager ) override
  {
    GEOSX_UNUSED_VAR( nodeManager );
    GEOSX_UNUSED_VAR( faceManager );
    //TODO ?
  }

  virtual void setupRelatedObjectsInRelations( MeshLevel const * const mesh ) override
  {
    GEOSX_UNUSED_VAR( mesh );
    //TODO ?
  }


  struct viewKeyStruct : ObjectManagerBase::viewKeyStruct
  {
    static constexpr auto elementVolumeString          = "elementVolume";
    static constexpr auto fineElementsListString       = "fineElements";
  };

private:
  NodeMapType m_toNodesRelation;

  array1d< localIndex > m_fineToCoarse;

  array1d< localIndex > m_nbFineCellsPerCoarseCell;
};
}

#endif