Enum Divergence 

pub enum Divergence {
    None,
    Gaussian {
        sigma_rad: f64,
    },
    UniformCone {
        half_angle_rad: f64,
    },
}

Beam divergence model.

Variants

None

No divergence: every particle gets the central direction.

Gaussian

Gaussian divergence: independent normal angular deviations with standard deviation sigma_rad in two orthogonal planes.

Fields

sigma_rad: f64

Standard deviation per plane, radians (finite, >= 0).

UniformCone

Directions uniform in solid angle within a cone.

Fields

half_angle_rad: f64

Cone half-angle, radians, in [0, π].

Implementations

impl Divergence

pub fn validate(&self) -> Result<(), CrystalError>

Check the parameters.

pub fn polar_cdf(&self, theta: f64) -> f64

Target CDF of the polar deflection ϑ (see the module docs). Divergence::None is a point mass at 0.

pub fn sample_deflection<R: Rng + ?Sized>(&self, rng: &mut R) -> (f64, f64)

Draw a deflection (ϑ, ψ): polar angle from the central direction and azimuth about it, radians. Takes two draws (none for Divergence::None); the parameters must be valid (Self::validate).

pub fn sample_direction<R: Rng + ?Sized>( &self, central: [f64; 3], rng: &mut R, ) -> [f64; 3]

Deflect the unit vector central by a sampled divergence. For Divergence::None this returns central unchanged and draws nothing.

Trait Implementations

impl Clone for Divergence

fn clone(&self) -> Divergence

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Divergence

impl Debug for Divergence

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Divergence

fn eq(&self, other: &Divergence) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Divergence

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Divergence