RandomFilter Struct Reference

Functor that returns 0 or 1 depending on a random draw per particle. More...

#include <FilterFunctors.H>

Public Member Functions
	RandomFilter (bool a_is_active, amrex::Real a_fraction)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool	operator() (const SuperParticleType &p, const amrex::RandomEngine &engine) const noexcept
	draw random number, return 1 if number < m_fraction, 1 otherwise

Private Attributes
bool	m_is_active
amrex::Real	m_fraction = 1.0
	select all particles if false

Detailed Description

Functor that returns 0 or 1 depending on a random draw per particle.

Constructor & Destructor Documentation

RandomFilter()

RandomFilter::RandomFilter ( bool a_is_active, amrex::Real a_fraction )

inline

constructor

Parameters

a_is_active	whether the test is active
a_fraction	fraction of particles to select

Member Function Documentation

operator()()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool RandomFilter::operator() ( const SuperParticleType & p, const amrex::RandomEngine & engine ) const

inlinenoexcept

draw random number, return 1 if number < m_fraction, 1 otherwise

Parameters

p	one particle
engine	the random number state and factory

Returns

whether or not the particle is selected

Member Data Documentation

m_fraction

amrex::Real RandomFilter::m_fraction = 1.0

private

select all particles if false

m_is_active

bool RandomFilter::m_is_active

private

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6102/Source/Particles/Filter/FilterFunctors.H