GeometryFilter Struct Reference

Functor that returns 1 if the particle is inside a given axis-aligned region defined by amrex::RealBox, 0 otherwise. More...

#include <FilterFunctors.H>

Public Member Functions
	GeometryFilter (bool a_is_active, amrex::RealBox a_domain)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool	operator() (const SuperParticleType &p, const amrex::RandomEngine &) const noexcept
	return 1 if the particle is within the region described by the RealBox

Private Attributes
bool	m_is_active
amrex::RealBox	m_domain

Detailed Description

Functor that returns 1 if the particle is inside a given axis-aligned region defined by amrex::RealBox, 0 otherwise.

Constructor & Destructor Documentation

GeometryFilter()

GeometryFilter::GeometryFilter ( bool a_is_active, amrex::RealBox a_domain )

inline

Member Function Documentation

operator()()

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

inlinenoexcept

return 1 if the particle is within the region described by the RealBox

Parameters

p	one particle

Returns

whether or not the particle is inside the region defined by m_domain

Member Data Documentation

m_domain

amrex::RealBox GeometryFilter::m_domain

private

Physical extent of the axis-aligned region used for particle check

m_is_active

bool GeometryFilter::m_is_active

private

Whether this diagnostics is activated. Select all particles if false

---

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

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