dae_info

Stable type · Variable classification

Tier: stable · Kind: type · Topic: Variable classification

Julia	TypeScript	Python	Rust	Go
not exported	not exported	not exported	`DaeInfo`	`DAEInfo`

Julia

Julia does not export this type.

TypeScript

TypeScript does not export this type.

Python

Python does not export this type.

Rust

pub struct DaeInfo {
    pub algebraic_equation_count: usize,
    pub per_model: HashMap<String, usize>,
    pub factored_equation_count: Option<usize>,
}

Summary of DAE classification stamped onto metadata.dae_info by discretize() per RFC §12.

algebraic_equation_count is the post-discretize() total across all models; per_model breaks it down by model name. factored_equation_count is rust-binding-specific — it reports the number of trivially substitutable algebraic equations the preprocessor eliminated before classification (see docs/rfcs/dae-binding-strategies.md). 0 on bindings that do not perform trivial factoring.

Source · Rust docs

type DAEInfo struct {
	// SystemClass is "ode" if ApplyDAEContract succeeded with no
	// residual algebraic equations, else "dae".
	SystemClass string
	// AlgebraicEquationCount is the number of algebraic equations
	// remaining after trivial factoring, summed across models.
	AlgebraicEquationCount int
	// TrivialFactoredCount is the number of algebraic equations
	// substituted out and removed during factoring.
	TrivialFactoredCount int
	// PerModel maps model name to residual algebraic equation count.
	PerModel map[string]int
	// PerModelFactored maps model name to equations factored out.
	PerModelFactored map[string]int
}

DAEInfo records the outcome of ApplyDAEContract on an ESMFile.

Source · Go docs