Struct rustitude_core::four_momentum::FourMomentum

pub struct FourMomentum(/* private fields */);

Implementations

impl FourMomentum

A four-momentum structure with helpful methods for boosts.

This is the basic structure of a Lorentz four-vector of the form $(E, \overrightarrow{p})$ where $E$ is the energy and $\overrightarrow{p}$ is the momentum.

Examples

use rustitude_core::prelude::*;

let vec_a = FourMomentum::new(1.3, 0.2, 0.3, 0.1);
let vec_b = FourMomentum::new(4.2, 0.5, 0.4, 0.5);

pub const fn new(e: f64, px: f64, py: f64, pz: f64) -> Self

Create a new FourMomentum from energy and momentum components.

Components are listed in the order $(E, p_x, p_y, p_z)$

pub fn e(&self) -> f64

pub fn px(&self) -> f64

pub fn py(&self) -> f64

pub fn pz(&self) -> f64

pub fn set_e(&mut self, value: f64)

pub fn set_px(&mut self, value: f64)

pub fn set_py(&mut self, value: f64)

pub fn set_pz(&mut self, value: f64)

pub fn m2(&self) -> f64

Calculate the invariant $ m^2 $ for this FourMomentum instance.

Calculates $m^2 = E^2 - \overrightarrow{p}^2$

Examples

use rustitude_core::prelude::*;

let vec_a = FourMomentum::new(20.0, 1.0, 0.2, -0.1);
//assert_eq!(vec_a.m2(), 20.0 * 20.0 - (1.0 * 1.0 + 0.0 * 0.2 + (-0.1) * (-0.1)));

pub fn m(&self) -> f64

Calculate the invariant $ m $ for this FourMomentum instance.

Calculates $m = \sqrt{E^2 - \overrightarrow{p}^2}$

See Also:

FourMomentum::m2

pub fn boost_along(&self, other: &Self) -> Self

Boosts an instance of FourMomentum along the $\overrightarrow{\beta}$ vector of another FourMomentum.

Calculates $\mathbf{\Lambda} \cdot \mathbf{x}$

Examples

#[macro_use]
use approx::*;

use rustitude_core::prelude::*;

let vec_a = FourMomentum::new(20.0, 1.0, -3.2, 4.0);
let vec_a_COM = vec_a.boost_along(&vec_a);
assert_abs_diff_eq!(vec_a_COM.px(), 0.0, epsilon = 1e-15);
assert_abs_diff_eq!(vec_a_COM.py(), 0.0, epsilon = 1e-15);
assert_abs_diff_eq!(vec_a_COM.pz(), 0.0, epsilon = 1e-15);

impl FourMomentum

pub fn momentum(&self) -> Vector3<f64>

Extract the 3-momentum as a nalgebra::Vector3<f64>

Examples

use rustitude_core::prelude::*;
use nalgebra::Vector3;

let vec_a = FourMomentum::new(20.0, 1.0, 0.2, -0.1);
assert_eq!(vec_a.momentum(), Vector3::new(1.0, 0.2, -0.1));

pub fn beta3(&self) -> Vector3<f64>

Construct the 3-vector $\overrightarrow{\beta}$ where

$\overrightarrow{\beta} = \frac{\overrightarrow{p}}{E}$

pub fn boost_matrix(&self) -> Matrix4<f64>

Construct the Lorentz boost matrix $\mathbf{\Lambda}$ where

\mathbf{\Lambda} = \begin{pmatrix}
\gamma & -\gamma \beta_x & -\gamma \beta_y & -\gamma \beta_z \\
-\gamma \beta_x & 1 + (\gamma - 1) \frac{\beta_x^2}{\overrightarrow{\beta}^2} & (\gamma - 1) \frac{\beta_x \beta_y}{\overrightarrow{\beta}^2} & (\gamma - 1) \frac{\beta_x \beta_z}{\overrightarrow{\beta}^2} \\
-\gamma \beta_y & (\gamma - 1) \frac{\beta_y \beta_x}{\overrightarrow{\beta}^2} & 1 + (\gamma - 1) \frac{\beta_y^2}{\overrightarrow{\beta}^2} & (\gamma - 1) \frac{\beta_y \beta_z}{\overrightarrow{\beta}^2} \\
-\gamma \beta_z & (\gamma - 1) \frac{\beta_z \beta_x}{\overrightarrow{\beta}^2} & (\gamma - 1) \frac{\beta_z \beta_y}{\overrightarrow{\beta}^2} & 1 + (\gamma - 1) \frac{\beta_z^2}{\overrightarrow{\beta}^2}
\end{pmatrix}

where $\overrightarrow{\beta} = \frac{\overrightarrow{p}}{E}$ and $\gamma = \frac{1}{\sqrt{1 - \overrightarrow{\beta}^2}}$.

Trait Implementations

impl Add for &FourMomentum

type Output = <FourMomentum as Add>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &FourMomentum) -> Self::Output

Performs the + operation.

impl Add for FourMomentum

type Output = FourMomentum

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Clone for FourMomentum

fn clone(&self) -> FourMomentum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FourMomentum

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

Formats the value using the given formatter.

impl Default for FourMomentum

fn default() -> FourMomentum

Returns the “default value” for a type.

impl Display for FourMomentum

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

Formats the value using the given formatter.

impl From<&FourMomentum> for Vector4<f64>

fn from(val: &FourMomentum) -> Self

Converts to this type from the input type.

impl From<&Matrix<f64, Const<4>, Const<1>, ArrayStorage<f64, 4, 1>>> for FourMomentum

fn from(value: &Vector4<f64>) -> Self

Converts to this type from the input type.

impl From<&Vec<f64>> for FourMomentum

fn from(value: &Vec<f64>) -> Self

Converts to this type from the input type.

impl From<FourMomentum> for Vector4<f64>

fn from(val: FourMomentum) -> Self

Converts to this type from the input type.

impl From<Matrix<f64, Const<4>, Const<1>, ArrayStorage<f64, 4, 1>>> for FourMomentum

fn from(value: Vector4<f64>) -> Self

Converts to this type from the input type.

impl From<Vec<f64>> for FourMomentum

fn from(value: Vec<f64>) -> Self

Converts to this type from the input type.

impl HasPyGilRef for FourMomentum

type AsRefTarget = PyCell<FourMomentum>

Utility type to make Py::as_ref work.

impl IntoPy<Py<PyAny>> for FourMomentum

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PartialEq for FourMomentum

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PyClass for FourMomentum

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for FourMomentum

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<FourMomentum>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<FourMomentum> for PyClassImplCollector<FourMomentum>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a FourMomentum

type Holder = Option<PyRef<'py, FourMomentum>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut FourMomentum

type Holder = Option<PyRefMut<'py, FourMomentum>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder ) -> PyResult<Self>

impl PyMethods<FourMomentum> for PyClassImplCollector<FourMomentum>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for FourMomentum

const NAME: &'static str = "FourMomentum"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> &PyType

👎Deprecated since 0.21.0: PyTypeInfo::type_object will be replaced by PyTypeInfo::type_object_bound in a future PyO3 version

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_type_of will be replaced by PyTypeInfo::is_type_of_bound in a future PyO3 version

Checks if object is an instance of this type or a subclass of this type.

fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_exact_type_of will be replaced by PyTypeInfo::is_exact_type_of_bound in a future PyO3 version

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Sub for &FourMomentum

type Output = <FourMomentum as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, rhs: &FourMomentum) -> Self::Output

Performs the - operation.

impl Sub for FourMomentum

type Output = FourMomentum

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<'a> Sum<&'a FourMomentum> for FourMomentum

fn sum<I: Iterator<Item = &'a Self>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for FourMomentum

impl DerefToPyAny for FourMomentum

impl Eq for FourMomentum

impl StructuralPartialEq for FourMomentum