Enum ConvexAdjointError 

pub enum ConvexAdjointError {
    Unconverged {
        step: usize,
        iterations: usize,
        residual: f64,
    },
    SingularKkt {
        step: usize,
    },
    BodyBodyContact {
        step: usize,
    },
    UnsupportedGeometry {
        step: usize,
        body: usize,
    },
}

Why an adjoint pass refused to produce a gradient.

Every variant is a loud refusal in place of a silently wrong number.

Variants

Unconverged

A step’s contact solve did not converge, so its solution is not a KKT point and the IFT does not apply.

Fields

step: usize

The offending step index.

iterations: usize

Iterations the solve used before giving up.

residual: f64

The residual it stalled at.

SingularKkt

The KKT matrix at a step’s converged active set is singular — the derivative genuinely does not exist there.

Fields

step: usize

The offending step index.

BodyBodyContact

👎Deprecated:

body-body contacts are supported; this variant is never constructed and will be removed in the next minor release

Formerly: the trajectory produced a body-body contact, which this adjoint did not cover.

Body-body contacts are differentiated now — see Anchor::Pair — and nothing constructs this variant any more. It is retained for one release so that a downstream match on ConvexAdjointError does not break, and because a caller that special-cased this refusal (falling back to a sampling optimizer, say) should get a compile-time nudge to delete that branch rather than silently keeping dead code that will never fire.

Fields

step: usize

👎Deprecated:

body-body contacts are supported; this variant is never constructed and will be removed in the next minor release

The step at which the body-body contact appeared.

UnsupportedGeometry

A detected contact could not be pinned to a material anchor on its body (unsupported geometry variant).

Fields

step: usize

The offending step index.

body: usize

The body carrying the unsupported geometry.

Trait Implementations

impl Clone for ConvexAdjointError

fn clone(&self) -> ConvexAdjointError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConvexAdjointError

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

Formats the value using the given formatter.

impl Display for ConvexAdjointError

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

Formats the value using the given formatter.

impl Error for ConvexAdjointError

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 PartialEq for ConvexAdjointError

fn eq(&self, other: &ConvexAdjointError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ConvexAdjointError