WarpXParIter Class Reference

#include <WarpXParticleContainer.H>

Inheritance diagram for WarpXParIter:

Public Member Functions
	WarpXParIter (ContainerType &pc, int level)
	WarpXParIter (ContainerType &pc, int level, amrex::MFItInfo &info)
const std::array< RealVector, PIdx::nattribs > &	GetAttribs () const
std::array< RealVector, PIdx::nattribs > &	GetAttribs ()
const RealVector &	GetAttribs (int comp) const
RealVector &	GetAttribs (int comp)
const IntVector &	GetiAttribs (int comp) const
IntVector &	GetiAttribs (int comp)
const RealVector &	GetAttribs (const std::string &name) const
RealVector &	GetAttribs (const std::string &name)
const IntVector &	GetiAttribs (const std::string &name) const
IntVector &	GetiAttribs (const std::string &name)
Public Member Functions inherited from amrex::ParIter_impl< SoAParticle< T_NArrayReal, T_NArrayInt >, T_NArrayReal, T_NArrayInt, Allocator, CellAssignor >
	ParIter_impl (ContainerType &pc, int level)
	ParIter_impl (ContainerType &pc, int level, MFItInfo &info)
Public Member Functions inherited from amrex::ParIterBase_impl< bool is_const, typename T_ParticleType, int NArrayReal, int NArrayInt, template< class > class Allocator, class CellAssignor >
	ParIterBase_impl (ContainerRef pc, int level)
	ParIterBase_impl (ContainerRef pc, int level, MFItInfo &info)
void	operator++ ()
ParticleTileRef	GetParticleTile () const
AoSRef	GetArrayOfStructs () const
SoARef	GetStructOfArrays () const
auto	numParticles () const
auto	numRealParticles () const
auto	numNeighborParticles () const
Long	capacity () const
int	GetLevel () const
std::pair< int, int >	GetPairIndex () const
const Geometry &	Geom (int lev) const
Public Member Functions inherited from amrex::MFIter
	MFIter (const FabArrayBase &fabarray, unsigned char flags_=0)
	MFIter (const FabArrayBase &fabarray, bool do_tiling)
	MFIter (const FabArrayBase &fabarray, const IntVect &tilesize, unsigned char flags_=0)
	MFIter (const BoxArray &ba, const DistributionMapping &dm, unsigned char flags_=0)
	MFIter (const BoxArray &ba, const DistributionMapping &dm, bool do_tiling)
	MFIter (const BoxArray &ba, const DistributionMapping &dm, const IntVect &tilesize, unsigned char flags_=0)
	MFIter (const FabArrayBase &fabarray, const MFItInfo &info)
	MFIter (const BoxArray &ba, const DistributionMapping &dm, const MFItInfo &info)
	MFIter (MFIter &&rhs)=default
	MFIter (MFIter const &)=delete
MFIter &	operator= (MFIter const &)=delete
MFIter &	operator= (MFIter &&)=delete
	~MFIter ()
Box	tilebox () const noexcept
Box	tilebox (const IntVect &nodal) const noexcept
Box	tilebox (const IntVect &nodal, const IntVect &ngrow) const noexcept
Box	nodaltilebox (int dir=-1) const noexcept
Box	growntilebox (int ng=-1000000) const noexcept
Box	growntilebox (const IntVect &ng) const noexcept
Box	grownnodaltilebox (int dir=-1, int ng=-1000000) const noexcept
Box	grownnodaltilebox (int dir, const IntVect &ng) const noexcept
Box	validbox () const noexcept
Box	fabbox () const noexcept
void	operator++ () noexcept
bool	isValid () const noexcept
int	index () const noexcept
int	length () const noexcept
int	LocalTileIndex () const noexcept
int	numLocalTiles () const noexcept
int	LocalIndex () const noexcept
const FabArrayBase &	theFabArrayBase () const noexcept
int	tileIndex () const noexcept
const DistributionMapping &	DistributionMap () const noexcept
void	Finalize ()

Additional Inherited Members
Public Types inherited from amrex::ParIter_impl< SoAParticle< T_NArrayReal, T_NArrayInt >, T_NArrayReal, T_NArrayInt, Allocator, CellAssignor >
typedef T_ParticleType	ParticleType
typedef T_CellAssignor	CellAssignor
typedef ParticleContainer_impl< ParticleType, NArrayReal, NArrayInt, Allocator, CellAssignor >	ContainerType
typedef typename ContainerType::ConstParticleType	ConstParticleType
typedef typename ContainerType::ParticleTileType	ParticleTileType
typedef typename ContainerType::AoS	AoS
typedef typename ContainerType::SoA	SoA
typedef typename SoA::RealVector	RealVector
typedef typename SoA::IntVector	IntVector
Public Types inherited from amrex::ParIterBase_impl< bool is_const, typename T_ParticleType, int NArrayReal, int NArrayInt, template< class > class Allocator, class CellAssignor >
typedef ParticleContainer_impl< T_ParticleType, NArrayReal, NArrayInt, Allocator, CellAssignor >	ContainerType
typedef typename ContainerType::ParticleTileType	ParticleTileType
typedef typename ContainerType::AoS	AoS
typedef typename ContainerType::SoA	SoA
typedef T_ParticleType	ParticleType
typedef typename SoA::RealVector	RealVector
typedef typename SoA::IntVector	IntVector
typedef typename ContainerType::ParticleVector	ParticleVector
Public Types inherited from amrex::MFIter
enum	Flags
Static Public Member Functions inherited from amrex::MFIter
static int	allowMultipleMFIters (int allow)
static int	currentDepth ()
Public Attributes inherited from amrex::MFIter
	Tiling
	AllBoxes
	NoTeamBarrier
Static Public Attributes inherited from amrex::ParIter_impl< SoAParticle< T_NArrayReal, T_NArrayInt >, T_NArrayReal, T_NArrayInt, Allocator, CellAssignor >
static constexpr int	NStructReal
static constexpr int	NStructInt
Static Public Attributes inherited from amrex::ParIterBase_impl< bool is_const, typename T_ParticleType, int NArrayReal, int NArrayInt, template< class > class Allocator, class CellAssignor >
static constexpr int	NStructReal
static constexpr int	NStructInt
Protected Member Functions inherited from amrex::MFIter
void	Initialize ()
Protected Attributes inherited from amrex::ParIterBase_impl< bool is_const, typename T_ParticleType, int NArrayReal, int NArrayInt, template< class > class Allocator, class CellAssignor >
int	m_level
ParticleTilePtr	m_particle_current_tile
ContainerPtr	m_pc
Protected Attributes inherited from amrex::MFIter
std::unique_ptr< FabArrayBase >	m_fa
const FabArrayBase *	fabArray
IntVect	tile_size
unsigned char	flags
int	currentIndex
int	beginIndex
int	endIndex
int	streams
IndexType	typ
bool	dynamic
bool	finalized
DeviceSync	device_sync
DeviceSync	device_sync_pre
DeviceSync	device_sync_post
const Vector< int > *	index_map
const Vector< int > *	local_index_map
const Vector< Box > *	tile_array
const Vector< int > *	local_tile_index_map
const Vector< int > *	num_local_tiles
Static Protected Attributes inherited from amrex::MFIter
static int	nextDynamicIndex
static int	depth
static int	allow_multiple_mfiters

Constructor & Destructor Documentation

WarpXParIter() [1/2]

WarpXParIter::WarpXParIter	(	ContainerType &	pc,
		int	level )

WarpXParIter() [2/2]

WarpXParIter::WarpXParIter	(	ContainerType &	pc,
		int	level,
		amrex::MFItInfo &	info )

Member Function Documentation

GetAttribs() [1/6]

std::array< RealVector, PIdx::nattribs > & WarpXParIter::GetAttribs ( )

inlinenodiscard

GetAttribs() [2/6]

const std::array< RealVector, PIdx::nattribs > & WarpXParIter::GetAttribs ( ) const

inlinenodiscard

GetAttribs() [3/6]

RealVector & WarpXParIter::GetAttribs ( const std::string & name )

inlinenodiscard

GetAttribs() [4/6]

const RealVector & WarpXParIter::GetAttribs ( const std::string & name ) const

inlinenodiscard

GetAttribs() [5/6]

RealVector & WarpXParIter::GetAttribs ( int comp )

inlinenodiscard

GetAttribs() [6/6]

const RealVector & WarpXParIter::GetAttribs ( int comp ) const

inlinenodiscard

GetiAttribs() [1/4]

IntVector & WarpXParIter::GetiAttribs ( const std::string & name )

inlinenodiscard

GetiAttribs() [2/4]

const IntVector & WarpXParIter::GetiAttribs ( const std::string & name ) const

inlinenodiscard

GetiAttribs() [3/4]

IntVector & WarpXParIter::GetiAttribs ( int comp )

inlinenodiscard

GetiAttribs() [4/4]

const IntVector & WarpXParIter::GetiAttribs ( int comp ) const

inlinenodiscard

---

The documentation for this class was generated from the following files:

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/26.07/Source/Particles/WarpXParticleContainer.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/26.07/Source/Particles/WarpXParticleContainer.cpp