ParticleSubRegion.hpp

/*
 * ------------------------------------------------------------------------------------------------------------
 * 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_MESH_PARTICLEELEMENTSUBREGION_HPP_
#define GEOS_MESH_PARTICLEELEMENTSUBREGION_HPP_
 
#include "mesh/generators/ParticleBlockABC.hpp"
#include "mesh/utilities/ComputationalGeometry.hpp"
#include "ParticleSubRegionBase.hpp"
 
 
namespace geos
{
 
class MeshLevel;
 
class ParticleSubRegion : public ParticleSubRegionBase
{
public:
 
  static string catalogName()
  { return "ParticleSubRegion"; }
 
  virtual string getCatalogName() const override final
  { return ParticleSubRegion::catalogName(); }
 
 
  ParticleSubRegion( string const & name, Group * const parent );
 
  virtual ~ParticleSubRegion() override;
 
 
 
  void setParticleRank( int const rank );
 
  void copyFromParticleBlock( ParticleBlockABC & particleBlock );
 
 
 
  template< typename LAMBDA >
  void forMaterials( LAMBDA lambda )
  {
    for( auto & constitutiveGroup : m_constitutiveGrouping )
    {
      lambda( constitutiveGroup );
    }
  }
 
 
  struct viewKeyStruct : public ParticleSubRegionBase::viewKeyStruct
  {
    static constexpr char const * constitutiveGroupingString() { return "ConstitutiveGrouping"; }
    static constexpr char const * constitutiveMapString() { return "ConstitutiveMap"; }
 
    dataRepository::ViewKey constitutiveGrouping  = { constitutiveGroupingString() };
    dataRepository::ViewKey constitutiveMap       = { constitutiveMapString() };
  }
  m_ParticleBlockSubRegionViewKeys;
 
  virtual viewKeyStruct & viewKeys() override { return m_ParticleBlockSubRegionViewKeys; }
  virtual viewKeyStruct const & viewKeys() const override { return m_ParticleBlockSubRegionViewKeys; }
 
private:
 
  map< string, localIndex_array > m_constitutiveGrouping;
 
  string_array m_externalPropertyNames;
 
};
 
} /* namespace geos */
 
#endif /* GEOS_MESH_CELLELEMENTSUBREGION_HPP_ */