#include <AMReX_StructOfArrays.H>

Public Types
using	IdCPU = amrex::PODVector< uint64_t, Allocator< uint64_t > >

using	RealVector = amrex::PODVector< ParticleReal, Allocator< ParticleReal > >

using	IntVector = amrex::PODVector< int, Allocator< int > >

Public Member Functions
void	define (int a_num_runtime_real, int a_num_runtime_int, std::vector< std::string > soa_rdata_names=nullptr, std::vector< std::string > soa_idata_names=nullptr)

int	NumRealComps () const noexcept

int	NumIntComps () const noexcept

IdCPU &	GetIdCPUData ()

std::array< RealVector, NReal > &	GetRealData ()

std::array< IntVector, NInt > &	GetIntData ()

const IdCPU &	GetIdCPUData () const

const std::array< RealVector, NReal > &	GetRealData () const

const std::array< IntVector, NInt > &	GetIntData () const

std::vector< std::string >	GetRealNames () const

std::vector< std::string >	GetIntNames () const

RealVector &	GetRealData (const int index)

const RealVector &	GetRealData (const int index) const

RealVector &	GetRealData (std::string const &name)

const RealVector &	GetRealData (std::string const &name) const

IntVector &	GetIntData (const int index)

const IntVector &	GetIntData (const int index) const

IntVector &	GetIntData (std::string const &name)

const IntVector &	GetIntData (std::string const &name) const

std::size_t	size () const
	Returns the total number of particles (real and neighbor)

bool	empty () const
	Returns whether the SoA is empty (i.e. has size() == 0)

int	numParticles () const
	Returns the number of real particles (excluding neighbors)

int	numRealParticles () const
	Returns the number of real particles (excluding neighbors)

int	numNeighborParticles () const
	Returns the number of neighbor particles (excluding reals)

int	numTotalParticles () const
	Returns the total number of particles (real and neighbor)

void	setNumNeighbors (int num_neighbors)

int	getNumNeighbors () const

void	resize (size_t count, GrowthStrategy strategy=GrowthStrategy::Poisson)

void	reserve (size_t capacity, GrowthStrategy strategy=GrowthStrategy::Poisson)

uint64_t *	idcpuarray ()

GpuArray< ParticleReal *, NReal >	realarray ()

GpuArray< int *, NInt >	intarray ()

Public Attributes
int	m_num_neighbor_particles {0}

Private Attributes
IdCPU	m_idcpu

std::array< RealVector, NReal >	m_rdata

std::array< IntVector, NInt >	m_idata

std::vector< RealVector >	m_runtime_rdata

std::vector< IntVector >	m_runtime_idata

std::vector< std::string > *	m_rdata_names = nullptr

std::vector< std::string > *	m_idata_names = nullptr

bool	m_defined {false}
	whether the runtime components are sized correctly

Member Typedef Documentation

◆ IdCPU

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

using amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::IdCPU = amrex::PODVector<uint64_t, Allocator<uint64_t> >

◆ IntVector

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

using amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::IntVector = amrex::PODVector<int, Allocator<int> >

◆ RealVector

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

using amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::RealVector = amrex::PODVector<ParticleReal, Allocator<ParticleReal> >

Member Function Documentation

◆ define()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

void amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::define	(	int	a_num_runtime_real,
		int	a_num_runtime_int,
		std::vector< std::string > *	soa_rdata_names = `nullptr`,
		std::vector< std::string > *	soa_idata_names = `nullptr`
	)

inline

◆ empty()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

bool amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::empty ( ) const

inline

Returns whether the SoA is empty (i.e. has size() == 0)

◆ GetIdCPUData() [1/2]

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

IdCPU & amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::GetIdCPUData ( )

inline

◆ GetIdCPUData() [2/2]

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

const IdCPU & amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::GetIdCPUData ( ) const

inline

Get access to the particle id/cpu Arrays

◆ GetIntData() [1/6]

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

std::array< IntVector, NInt > & amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::GetIntData ( )

inline

◆ GetIntData() [2/6]

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

const std::array< IntVector, NInt > & amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::GetIntData ( ) const

inline

Get access to the particle Int Arrays (only compile-time components)

◆ GetIntData() [3/6]

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

IntVector & amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::GetIntData ( const int index )

inline

Get access to a particle Int component Array (compile-time and runtime component)

Parameters

index component with 0...NInt-1 compile-time and NInt... runtime arguments

◆ GetIntData() [4/6]

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

const IntVector & amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::GetIntData ( const int index ) const

inline

Get access to a particle Int component Array (compile-time and runtime component)

Parameters

index component with 0...NInt-1 compile-time and NInt... runtime arguments

Returns

◆ GetIntData() [5/6]

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

IntVector & amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::GetIntData ( std::string const & name )

inline

Get access to a particle Int component Array (compile-time and runtime component)

Parameters

name	component names with 0...NInt-1 compile-time and NInt... runtime arguments

Returns

◆ GetIntData() [6/6]

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

const IntVector & amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::GetIntData ( std::string const & name ) const

inline

Get access to a particle Int component Array (compile-time and runtime component)

Parameters

name	component names with 0...NInt-1 compile-time and NInt... runtime arguments

Returns

◆ GetIntNames()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

std::vector< std::string > amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::GetIntNames ( ) const

inline

Get the names for the int SoA components

◆ getNumNeighbors()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

int amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::getNumNeighbors ( ) const

inline

◆ GetRealData() [1/6]

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

std::array< RealVector, NReal > & amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::GetRealData ( )

inline

◆ GetRealData() [2/6]

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

const std::array< RealVector, NReal > & amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::GetRealData ( ) const

inline

Get access to the particle Real Arrays (only compile-time components)

◆ GetRealData() [3/6]

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

RealVector & amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::GetRealData ( const int index )

inline

Get access to a particle Real component Array (compile-time and runtime component)

Parameters

index component with 0...NReal-1 compile-time and NReal... runtime arguments

◆ GetRealData() [4/6]

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

const RealVector & amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::GetRealData ( const int index ) const

inline

Get access to a particle Real component Array (compile-time and runtime component)

Parameters

index component with 0...NReal-1 compile-time and NReal... runtime arguments

◆ GetRealData() [5/6]

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

RealVector & amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::GetRealData ( std::string const & name )

inline

Get access to a particle Real component Array (compile-time and runtime component)

Parameters

name	named component component with 0...NReal-1 compile-time and NReal... runtime arguments

◆ GetRealData() [6/6]

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

const RealVector & amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::GetRealData ( std::string const & name ) const

inline

Get access to a particle Real component Array (compile-time and runtime component)

Parameters

name	named component component with 0...NReal-1 compile-time and NReal... runtime arguments

◆ GetRealNames()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

std::vector< std::string > amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::GetRealNames ( ) const

inline

Get the names for the real SoA components

◆ idcpuarray()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

uint64_t * amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::idcpuarray ( )

inline

◆ intarray()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

GpuArray< int *, NInt > amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::intarray ( )

inline

◆ NumIntComps()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

int amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::NumIntComps ( ) const

inlinenoexcept

◆ numNeighborParticles()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

int amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::numNeighborParticles ( ) const

inline

Returns the number of neighbor particles (excluding reals)

◆ numParticles()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

int amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::numParticles ( ) const

inline

Returns the number of real particles (excluding neighbors)

◆ NumRealComps()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

int amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::NumRealComps ( ) const

inlinenoexcept

◆ numRealParticles()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

int amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::numRealParticles ( ) const

inline

Returns the number of real particles (excluding neighbors)

◆ numTotalParticles()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

int amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::numTotalParticles ( ) const

inline

Returns the total number of particles (real and neighbor)

◆ realarray()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

GpuArray< ParticleReal *, NReal > amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::realarray ( )

inline

◆ reserve()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

void amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::reserve	(	size_t	capacity,
		GrowthStrategy	strategy = `GrowthStrategy::Poisson`
	)

inline

◆ resize()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

void amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::resize	(	size_t	count,
		GrowthStrategy	strategy = `GrowthStrategy::Poisson`
	)

inline

◆ setNumNeighbors()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

void amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::setNumNeighbors ( int num_neighbors )

inline

◆ size()

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

std::size_t amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::size ( ) const

inline

Returns the total number of particles (real and neighbor)

Member Data Documentation

◆ m_defined

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

bool amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::m_defined {false}

private

whether the runtime components are sized correctly

◆ m_idata

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

std::array< IntVector, NInt> amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::m_idata

private

◆ m_idata_names

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

std::vector<std::string>* amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::m_idata_names = nullptr

private

◆ m_idcpu

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

IdCPU amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::m_idcpu

private

◆ m_num_neighbor_particles

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

int amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::m_num_neighbor_particles {0}

◆ m_rdata

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

std::array<RealVector, NReal> amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::m_rdata

private

◆ m_rdata_names

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

std::vector<std::string>* amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::m_rdata_names = nullptr

private

◆ m_runtime_idata

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

std::vector<IntVector > amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::m_runtime_idata

private

◆ m_runtime_rdata

template<int NReal, int NInt, template< class > class Allocator = DefaultAllocator, bool use64BitIdCpu = false>

std::vector<RealVector> amrex::StructOfArrays< NReal, NInt, Allocator, use64BitIdCpu >::m_runtime_rdata

private

The documentation for this struct was generated from the following file:

/home/runner/work/amrex/amrex/Src/Particle/AMReX_StructOfArrays.H

Public Types

Public Member Functions

Public Attributes

Private Attributes

Member Typedef Documentation

◆ IdCPU

◆ IntVector

◆ RealVector

Member Function Documentation

◆ define()

◆ empty()

◆ GetIdCPUData() [1/2]

◆ GetIdCPUData() [2/2]

◆ GetIntData() [1/6]

◆ GetIntData() [2/6]

◆ GetIntData() [3/6]

◆ GetIntData() [4/6]

◆ GetIntData() [5/6]

◆ GetIntData() [6/6]

◆ GetIntNames()

◆ getNumNeighbors()

◆ GetRealData() [1/6]

◆ GetRealData() [2/6]

◆ GetRealData() [3/6]

◆ GetRealData() [4/6]

◆ GetRealData() [5/6]

◆ GetRealData() [6/6]

◆ GetRealNames()

◆ idcpuarray()

◆ intarray()

◆ NumIntComps()

◆ numNeighborParticles()

◆ numParticles()

◆ NumRealComps()

◆ numRealParticles()

◆ numTotalParticles()

◆ realarray()

◆ reserve()

◆ resize()

◆ setNumNeighbors()

◆ size()

Member Data Documentation

◆ m_defined

◆ m_idata

◆ m_idata_names

◆ m_idcpu

◆ m_num_neighbor_particles

◆ m_rdata

◆ m_rdata_names

◆ m_runtime_idata

◆ m_runtime_rdata