Skip to main content

Diagnostics

Struct Diagnostics 

Source
pub struct Diagnostics {
    pub history: Vec<GlobalDiagnostics>,
}
Expand description

Accumulates time series of GlobalDiagnostics.

Fields§

§history: Vec<GlobalDiagnostics>

Implementations§

Source§

impl Diagnostics

Source

pub fn compute( &mut self, repr: &dyn PhaseSpaceRepr, potential: &PotentialField, time: f64, dx3: f64, ) -> GlobalDiagnostics

Compute all global diagnostics from the current representation and potential. dx3 is the spatial cell volume dx1dx2dx3.

Source

pub fn compute_with_density( &mut self, repr: &dyn PhaseSpaceRepr, density: &DensityField, potential: &PotentialField, time: f64, dx3: f64, ) -> GlobalDiagnostics

Compute all global diagnostics using a pre-computed density field.

This avoids redundant compute_density() calls when the caller already has the density (e.g. from a Poisson solve in the same step).

Source

pub fn kinetic_energy(repr: &dyn PhaseSpaceRepr) -> f64

Total kinetic energy T = ½∫fv² dx³dv³.

Returns 0.0 if the representation does not support kinetic energy computation.

Source

pub fn potential_energy( density: &DensityField, potential: &PotentialField, dx3: f64, ) -> f64

Total potential energy W = ½∫ρΦ dx³. dx3 is the spatial cell volume.

Source

pub fn virial_ratio(t: f64, w: f64) -> f64

Virial ratio 2T/|W|. Equals 1.0 at equilibrium.

Source

pub fn max_relative_drift<F: Fn(&GlobalDiagnostics) -> f64>( &self, quantity: F, ) -> f64

Maximum relative drift of a conserved quantity over the full history.

Returns |Q(t) - Q(0)| / |Q(0)| for the worst timestep, or 0 if history is empty.

Source

pub fn conservation_summary(&self) -> ConservationSummary

Conservation summary: max relative drifts in mass, energy, and Casimir C₂.

Source

pub fn density_profile(density: &DensityField, dx: [f64; 3]) -> Vec<(f64, f64)>

Spherically averaged density profile ρ(r) at current timestep. Bins density cells by radius from domain centre, returns (r_bin, ρ_avg) pairs.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<T> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,