ParticleRegion.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * 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_PARTICLEREGION_HPP_
#define GEOS_MESH_PARTICLEREGION_HPP_
 
#include "ParticleRegionBase.hpp"
 
namespace geos
{
class ParticleRegion : public ParticleRegionBase
{
public:
 
 
 
  ParticleRegion( string const & name, Group * const parent );
 
  ParticleRegion() = delete;
 
  virtual ~ParticleRegion() override;
 
 
  static string catalogName()
  { return "ParticleRegion"; }
 
  virtual string getCatalogName() const override final
  { return ParticleRegion::catalogName(); }
 
 
 
  void addParticleBlockName( string const & particleBlockName )
  {
    m_particleBlockNames.emplace_back( particleBlockName );
  }
 
  string_array getParticleBlockNames()
  {
    return m_particleBlockNames;
  }
 
  virtual void generateMesh( Group & particleBlocks ) override;
 
 
  array2d< real64 > getParticleCorners() const;
 
  struct viewKeyStruct : public ParticleRegionBase::viewKeyStruct
  {
    static constexpr char const * sourceParticleBlockNamesString() {return "particleBlocks"; }
  };
 
 
private:
 
  // Cell block names
  string_array m_particleBlockNames;
 
};
 
} /* namespace geos */
 
#endif /* GEOS_MESH_PARTICLEREGION_HPP_ */