A collection of SampleableObject objects. It can be used to sample from by selecting a volume weighted by surface area or volume. More...

Public Member Functions
const SampleableObject &	SurfaceWeightedRand () const
	Select a `SampleableObject` from the collection, weighted by surface area.
const SampleableObject &	VolumeWeightedRand (bool weight_by_mass) const
	Select a `SampleableObject` from the collection, weighted by volume.
bool	IsInside (const G4ThreeVector &vertex) const
size_t	size () const
SampleableObject &	at (size_t i)
template<typename... Args>
void	emplace_back (Args &&... args)
bool	empty () const
SampleableObject &	back ()
void	clear ()
void	insert (SampleableObjectCollection &other)
void	recalc_total (bool weigh_by_mass, int mass_isotope_z, int mass_istotope_n)

Public Attributes
std::vector< SampleableObject >	data
double	total_volume = 0
double	total_mass = 0
double	total_surface = 0

Detailed Description

A collection of SampleableObject objects. It can be used to sample from by selecting a volume weighted by surface area or volume.

Member Function Documentation

const RMGVertexConfinement::SampleableObject & RMGVertexConfinement::SampleableObjectCollection::SurfaceWeightedRand ( ) const

nodiscard

Select a SampleableObject from the collection, weighted by surface area.

const RMGVertexConfinement::SampleableObject & RMGVertexConfinement::SampleableObjectCollection::VolumeWeightedRand ( bool weight_by_mass ) const

nodiscard

Select a SampleableObject from the collection, weighted by volume.

Parameters

weight_by_mass A flag of whether the volume weighting should be done by mass and not by volume.

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

/home/docs/checkouts/readthedocs.org/user_builds/remage/checkouts/latest/include/RMGVertexConfinement.hh
/home/docs/checkouts/readthedocs.org/user_builds/remage/checkouts/latest/src/RMGVertexConfinement.cc