Skip to main content

MergerIC

Struct MergerIC 

Source
pub struct MergerIC {
    pub body1: Box<dyn IsolatedEquilibrium>,
    pub mass1: Decimal,
    pub body2: Box<dyn IsolatedEquilibrium>,
    pub mass2: Decimal,
    pub separation: [f64; 3],
    pub relative_velocity: [f64; 3],
    pub impact_parameter: Decimal,
    /* private fields */
}
Expand description

Binary merger initial conditions: two displaced and boosted equilibria.

The combined distribution is f(x,v) = f1(x-x1, v-v1) + f2(x-x2, v-v2), exact for collisionless systems before the halos begin to interact.

Fields§

§body1: Box<dyn IsolatedEquilibrium>

First body’s equilibrium distribution (e.g. Plummer, King, NFW).

§mass1: Decimal

Total mass of the first body.

§body2: Box<dyn IsolatedEquilibrium>

Second body’s equilibrium distribution.

§mass2: Decimal

Total mass of the second body.

§separation: [f64; 3]

Initial separation vector between the two centres (body2 - body1).

§relative_velocity: [f64; 3]

Relative velocity of body 2 with respect to body 1.

§impact_parameter: Decimal

Transverse offset for off-axis encounters; zero gives a head-on merger.

Implementations§

Source§

impl MergerIC

Source

pub fn new( body1: Box<dyn IsolatedEquilibrium>, mass1: f64, body2: Box<dyn IsolatedEquilibrium>, mass2: f64, separation: [f64; 3], relative_velocity: [f64; 3], impact_parameter: f64, ) -> Self

Create a MergerIC from f64 parameters (backward-compatible).

Source

pub fn new_decimal( body1: Box<dyn IsolatedEquilibrium>, mass1: Decimal, body2: Box<dyn IsolatedEquilibrium>, mass2: Decimal, separation: [f64; 3], relative_velocity: [f64; 3], impact_parameter: Decimal, ) -> Self

Create a MergerIC from Decimal parameters (exact config).

Source

pub fn sample_on_grid( &self, domain: &Domain, progress: Option<&StepProgress>, ) -> PhaseSpaceSnapshot

Sample both components on the grid and sum. Body 1 is centred at (-sep/2, 0, 0) with velocity (-v_rel/2, 0, 0). Body 2 is centred at (+sep/2, 0, 0) with velocity (+v_rel/2, 0, 0).

Source

pub fn validate(&self, domain: &Domain) -> Result<()>

Check that both components fit within the domain.

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,