Enum SimulationError

pub enum SimulationError {
Show 16 variants CalcError(CalcError), DecomposeError(DecomposeError), TimeError(TimeError), ControllerError(ControllerError), DivisionError(DivisionError), DeathError(DeathError), BoundaryError(BoundaryError), DrawingError(DrawingError), IndexError(IndexError), SendError(String), ReceiveError(RecvError), StorageError(StorageError), IoError(Error), RngError(RngError), OtherThreadError(String), Pyo3Error(PyErr),
}
Available on crate feature chili only.
Expand description

Covers all errors that can occur in this Simulation The errors are listed from very likely to be a user error from almost certainly an internal error.

§Categorization of errors

Some errors are more likely to be occurring due to an incorrect usage by an end user while others are highly likely to be due to some internal implementation problem. Independent of the exact reason, why they are occurring, some can be handled explicitly while others force an abort of the simulation. See also HandlingStrategy.

VariantConcept ImplementationEngine-FaultTime Increment
CalcError8/102/100/10
DecomposeError7/103/100/10
ControllerError8/101/101/10
DivisionError8/101/101/10
DeathError8/101/101/10
BoundaryError7/101/102/10
DrawingError9/101/100/10
IndexError6/102/102/10
SendError3/106/101/10
ReceiveError3/106/101/10
StorageError3/107/100/10
RngError1/108/101/10
IoError1/109/100/10

Variants§

§

CalcError(CalcError)

Occurs during calculations of any mathematical update steps such as Interaction between cells.

§

DecomposeError(DecomposeError)

Error associated to splitting up the simulation domain into chunks in order to effectively process it in parallel.

§

TimeError(TimeError)

Related to time-stepping events. See crate::time.

§

ControllerError(ControllerError)

Error-type specifically related to the Controller trait.

§

DivisionError(DivisionError)

An error specific to cell-division events by the

Cycle trait.

§

DeathError(DeathError)

Related to the PhasedDeath event. This error can only occcurr during the update_conditional_phased_death method.

§

BoundaryError(BoundaryError)

Enforcing boundary conditions on cells can exhibhit this boundary error.

§

DrawingError(DrawingError)

§

IndexError(IndexError)

Mostly caused by trying to find a voxel by its index. This error can also occcurr when applying too large simulation-steps.

§

SendError(String)

Sending information between threads fails

§

ReceiveError(RecvError)

Receiving information from another thread fails

§

StorageError(StorageError)

Storing results fails

§

IoError(Error)

When writing to output files or reading from them. See std::io::Error

§

RngError(RngError)

Error related to random number generation by the rand_chacha::ChaCha8Rng struct.

§

OtherThreadError(String)

Only occurs when another thread returns an error

§

Pyo3Error(PyErr)

Error related to [pyo3]

Trait Implementations§

§

impl Debug for SimulationError

§

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

Formats the value using the given formatter. Read more
§

impl Display for SimulationError

§

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

Formats the value using the given formatter. Read more
§

impl Error for SimulationError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
§

impl From<BoundaryError> for SimulationError

§

fn from(err: BoundaryError) -> SimulationError

Converts to this type from the input type.
§

impl From<CalcError> for SimulationError

§

fn from(err: CalcError) -> SimulationError

Converts to this type from the input type.
§

impl From<ControllerError> for SimulationError

§

fn from(err: ControllerError) -> SimulationError

Converts to this type from the input type.
§

impl From<DeathError> for SimulationError

§

fn from(err: DeathError) -> SimulationError

Converts to this type from the input type.
§

impl From<DecomposeError> for SimulationError

§

fn from(err: DecomposeError) -> SimulationError

Converts to this type from the input type.
§

impl From<DivisionError> for SimulationError

§

fn from(err: DivisionError) -> SimulationError

Converts to this type from the input type.
§

impl From<DrawingError> for SimulationError

§

fn from(err: DrawingError) -> SimulationError

Converts to this type from the input type.
§

impl From<Error> for SimulationError

§

fn from(err: Error) -> SimulationError

Converts to this type from the input type.
§

impl From<IndexError> for SimulationError

§

fn from(err: IndexError) -> SimulationError

Converts to this type from the input type.
§

impl From<PyErr> for SimulationError

§

fn from(err: PyErr) -> SimulationError

Converts to this type from the input type.
§

impl From<RecvError> for SimulationError

§

fn from(err: RecvError) -> SimulationError

Converts to this type from the input type.
§

impl From<RngError> for SimulationError

§

fn from(err: RngError) -> SimulationError

Converts to this type from the input type.
§

impl<T> From<SendError<T>> for SimulationError

§

fn from(_err: SendError<T>) -> SimulationError

Converts to this type from the input type.
§

impl From<StorageError> for SimulationError

§

fn from(err: StorageError) -> SimulationError

Converts to this type from the input type.
§

impl From<TimeError> for SimulationError

§

fn from(err: TimeError) -> SimulationError

Converts to this type from the input type.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> Ungil for T
where T: Send,