Enum SimulationError

pub enum SimulationError {
    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),
}

Available on crate feature chili only.

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.

Variant	Concept Implementation	Engine-Fault	Time Increment
CalcError	8/10	2/10	0/10
DecomposeError	7/10	3/10	0/10
ControllerError	8/10	1/10	1/10
DivisionError	8/10	1/10	1/10
DeathError	8/10	1/10	1/10
BoundaryError	7/10	1/10	2/10
DrawingError	9/10	1/10	0/10
IndexError	6/10	2/10	2/10
SendError	3/10	6/10	1/10
ReceiveError	3/10	6/10	1/10
StorageError	3/10	7/10	0/10
RngError	1/10	8/10	1/10
IoError	1/10	9/10	0/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)

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 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

Trait Implementations

impl Debug for SimulationError

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

Formats the value using the given formatter.

impl Display for SimulationError

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

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) -> Self

Converts to this type from the input type.

impl From<CalcError> for SimulationError

fn from(err: CalcError) -> Self

Converts to this type from the input type.

impl From<ControllerError> for SimulationError

fn from(err: ControllerError) -> Self

Converts to this type from the input type.

impl From<DeathError> for SimulationError

fn from(err: DeathError) -> Self

Converts to this type from the input type.

impl From<DecomposeError> for SimulationError

fn from(err: DecomposeError) -> Self

Converts to this type from the input type.

impl From<DivisionError> for SimulationError

fn from(err: DivisionError) -> Self

Converts to this type from the input type.

impl From<DrawingError> for SimulationError

fn from(err: DrawingError) -> Self

Converts to this type from the input type.

impl From<Error> for SimulationError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<IndexError> for SimulationError

fn from(err: IndexError) -> Self

Converts to this type from the input type.

impl From<RecvError> for SimulationError

fn from(err: RecvError) -> Self

Converts to this type from the input type.

impl From<RngError> for SimulationError

fn from(err: RngError) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<SimulationError> for PyErr

fn from(value: SimulationError) -> Self

Converts to this type from the input type.

impl From<StorageError> for SimulationError

fn from(err: StorageError) -> Self

Converts to this type from the input type.

impl From<TimeError> for SimulationError

fn from(err: TimeError) -> Self

Converts to this type from the input type.