ParticleBlockABC.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_PARTICLEBLOCKABC_HPP
#define GEOS_PARTICLEBLOCKABC_HPP
 
#include "mesh/ParticleType.hpp"
 
#include "dataRepository/Group.hpp"
#include "common/DataTypes.hpp"
 
#include <vector>
 
namespace geos
{
 
class ParticleBlockABC : public dataRepository::Group
{
public:
 
  ParticleBlockABC( string const & name,
                    Group * const parent )
    :
    Group( name, parent )
  { }
 
  virtual ParticleType getParticleType() const = 0;
 
  virtual array1d< globalIndex > getParticleID() const = 0;
 
  virtual array1d< int > getParticleGroup() const = 0;
 
  virtual array1d< int > getParticleSurfaceFlag() const = 0;
 
  virtual array1d< real64 > getParticleDamage() const = 0;
 
  virtual array1d< real64 > getParticleStrengthScale() const = 0;
 
  virtual array2d< real64 > getParticleCenter() const = 0;
 
  virtual array2d< real64 > getParticleVelocity() const = 0;
 
  virtual array2d< real64 > getParticleMaterialDirection() const = 0;
 
  virtual array1d< real64 > getParticleVolume() const = 0;
 
  virtual array3d< real64 > getParticleRVectors() const = 0;
 
  virtual bool hasRVectors() const = 0;
 
  virtual localIndex numParticles() const = 0;
 
  virtual array1d< globalIndex > localToGlobalMap() const = 0;
 
  template< typename LAMBDA >
  void forExternalProperties( LAMBDA && lambda )
  {
    for( auto * wrapperBase: this->getExternalProperties() )
    {
      lambda( *wrapperBase );
    }
  }
 
private:
  virtual std::list< dataRepository::WrapperBase * > getExternalProperties() = 0;
};
 
}
 
#endif //GEOS_CELLBLOCKABC_HPP