Skip to main content

Simulation

caustic

Struct Simulation 

Source 
pub struct Simulation {
Show 18 fields
    pub domain: Domain,
    pub repr: Box<dyn PhaseSpaceRepr>,
    pub poisson: Box<dyn PoissonSolver>,
    pub advector: Box<dyn Advector>,
    pub integrator: Box<dyn TimeIntegrator>,
    pub diagnostics: Diagnostics,
    pub io: IOManager,
    pub exit_evaluator: ExitEvaluator,
    pub opts: OptionalParams,
    pub lomac: Option<LoMaC>,
    pub g: f64,
    pub time: f64,
    pub step: u64,
    pub start_time: Instant,
    pub last_step_timings: StepTimings,
    pub cached_density: Option<DensityField>,
    pub cached_potential: Option<PotentialField>,
    pub cached_acceleration: Option<AccelerationField>,
    /* private fields */

}
Expand description

The top-level simulation object. Owns all solver components.

Fields§

§domain: Domain§repr: Box<dyn PhaseSpaceRepr>§poisson: Box<dyn PoissonSolver>§advector: Box<dyn Advector>§integrator: Box<dyn TimeIntegrator>§diagnostics: Diagnostics§io: IOManager§exit_evaluator: ExitEvaluator§opts: OptionalParams§lomac: Option<LoMaC>

Optional LoMaC conservation framework. When active, projects the distribution function after each time step to restore exact local conservation of mass, momentum, and energy.

§g: f64§time: f64§step: u64§start_time: Instant§last_step_timings: StepTimings

Per-step phase timing breakdown from the most recent step() call. Includes integrator sub-step timings + post-advance diagnostics timing.

§cached_density: Option<DensityField>

Cached density from the most recent step, for TUI reuse.

§cached_potential: Option<PotentialField>

Cached potential from the most recent step, for TUI reuse.

§cached_acceleration: Option<AccelerationField>

Cached acceleration from the most recent step, for TUI reuse.

Implementations§

Source§

impl Simulation

Source

pub fn builder() -> SimulationBuilder

Create a SimulationBuilder with no components set.

Source

pub fn run(&mut self) -> Result<ExitPackage>

Run the simulation to completion and return the exit package.

Source

pub fn step(&mut self) -> Result<Option<ExitReason>>

Advance by a single timestep. Returns Some(reason) if the simulation should stop.

Source

pub fn set_progress(&mut self, p: Arc<StepProgress>)

Attach shared progress state for intra-step TUI visibility. Propagates to the integrator so sub-step phases are reported.

Source

pub fn current_time(&self) -> f64

Current simulation time.

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,