Enum SimulationError

pub enum SimulationError {
    CalcError(CalcError),
    TimeError(TimeError),
    ControllerError(ControllerError),
    DivisionError(DivisionError),
    DeathError(DeathError),
    BoundaryError(BoundaryError),
    DrawingError(DrawingError),
    IndexError(IndexError),
    SendError(String),
    ReceiveError(RecvError),
    StorageError(StorageError),
    IoError(Error),
    RequestError(RequestError),
    RngError(RngError),
    ThreadingError(ThreadPoolBuildError),
}

Available on crate feature cpu_os_threads only.

Covers all errors that can occur in this Simulation

This main error type should be derivable from errors arising during the simulation process. It is required for custom error types MyCustomError of the engine to implement the From<MyCustomError> for SimulationError.

Errors are separated by their ability to be recovered, ignored or handled otherwise. Since this crate aims to provide an adaptive solving approach, it is desired to have a fallback mechanism which can be called for errors which may arise due to precision problems.

Variants

CalcError(CalcError)

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

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 occur during the update_conditional_phased_death method.

BoundaryError(BoundaryError)

Enforcing boundary conditions on cells can exhibhit this boundary error.

DrawingError(DrawingError)

Plotting results. See also cellular_raza_concepts::PlotSelf and cellular_raza_concepts::CreatePlottingRoot.

IndexError(IndexError)

Mostly caused by trying to find a voxel by its index. This error can also occur 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

RequestError(RequestError)

Occurs when requested data could not be returned

RngError(RngError)

Errors related to rand and its functionalities

ThreadingError(ThreadPoolBuildError)

Errors surrounding construction of rayon::ThreadPool.

Trait Implementations

impl Debug for SimulationError

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

Formats the value using the given formatter.

impl Display for SimulationError

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

Formats the value using the given formatter.

impl Error for SimulationError

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

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

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

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.

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<DivisionError> for SimulationError

fn from(err: DivisionError) -> SimulationError

Converts to this type from the input type.

impl<E> From<DrawingAreaErrorKind<E>> for SimulationError

where E: Error + Send + Sync,

fn from(drawing_error: DrawingAreaErrorKind<E>) -> 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<RecvError> for SimulationError

fn from(err: RecvError) -> SimulationError

Converts to this type from the input type.

impl From<RequestError> for SimulationError

fn from(err: RequestError) -> 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<ThreadPoolBuildError> for SimulationError

fn from(err: ThreadPoolBuildError) -> 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.