IParticleFamily.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IParticleFamily.h                                           (C) 2000-2025 */
/*                                                                           */
/* Interface of a particle family.                                           */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_IPARTICLEFAMILY_H
#define ARCANE_CORE_IPARTICLEFAMILY_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
#include "arcane/core/ItemTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT IParticleFamily
{
 public:
 
  virtual ~IParticleFamily() {} //<! Releases resources
 
 public:
 
  virtual void build() = 0;

  virtual void setEnableGhostItems(bool value) = 0;

  virtual bool getEnableGhostItems() const = 0;
 
 public:

  virtual String name() const = 0;

  virtual String fullName() const = 0;

  virtual Integer nbItem() const = 0;

  virtual ItemGroup allItems() const = 0;
 
 public:

  virtual ParticleVectorView addParticles(Int64ConstArrayView unique_ids,
                                          Int32ArrayView items_local_id) = 0;
  virtual ParticleVectorView addParticles2(Int64ConstArrayView unique_ids,
                                           Int32ConstArrayView owners,
                                           Int32ArrayView items) = 0;

  virtual ParticleVectorView addParticles(Int64ConstArrayView unique_ids,
                                          Int32ConstArrayView cells_local_id,
                                          Int32ArrayView items_local_id) = 0;
 
  virtual void removeParticles(Int32ConstArrayView items_local_id) = 0;

  virtual void endUpdate() = 0;

  virtual void setParticleCell(Particle particle, Cell new_cell) = 0;

  virtual void setParticlesCell(ParticleVectorView particles, CellVectorView new_cells) = 0;
 
 public:

  virtual void exchangeParticles() = 0;
 
 public:

  virtual IItemFamily* itemFamily() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif