Struct DAEStructure

Source

pub struct DAEStructure<F: Float + FromPrimitive + Debug + ScalarOperand + AddAssign + SubAssign + MulAssign + DivAssign + Display + LowerExp + Sum + IntegrateFloat> {
    pub n_differential: usize,
    pub n_algebraic: usize,
    pub n_diff_eqs: usize,
    pub n_alg_eqs: usize,
    pub index: DAEIndex,
    pub diff_index: usize,
    pub constraint_jacobian: Option<Array2<F>>,
    pub derivative_jacobian: Option<Array2<F>>,
    pub incidence_matrix: Option<Array2<bool>>,
    pub variable_dependencies: Option<Vec<Vec<usize>>>,
    pub equation_dependencies: Option<Vec<Vec<usize>>>,
}

Expand description

Index structure of a DAE system

Fields§

§n_differential: usize

Number of differential variables

§n_algebraic: usize

Number of algebraic variables

§n_diff_eqs: usize

Number of differential equations

§n_alg_eqs: usize

Number of algebraic equations

§index: DAEIndex

Index of the DAE system

§diff_index: usize

Differentiation index (number of differentiations needed to reach an ODE)

§constraint_jacobian: Option<Array2<F>>

Jacobian of the constraint equations with respect to algebraic variables

§derivative_jacobian: Option<Array2<F>>

Jacobian of the constraint equations with respect to derivatives

§incidence_matrix: Option<Array2<bool>>

Incidence matrix showing dependencies between equations and variables

§variable_dependencies: Option<Vec<Vec<usize>>>

Variables that appear in each equation with non-zero coefficients

§equation_dependencies: Option<Vec<Vec<usize>>>

Equations in which each variable appears with non-zero coefficients

Implementations§

Source §

impl<F: Float + FromPrimitive + Debug + ScalarOperand + AddAssign + SubAssign + MulAssign + DivAssign + Display + LowerExp + Sum + IntegrateFloat> DAEStructure<F>

Source

pub fn new_semi_explicit(n_differential: usize, nalgebraic: usize) -> Self

Create a new DAE structure for a semi-explicit system

Source

pub fn new_fully_implicit(n_equations: usize, nvariables: usize) -> Self

Create a new DAE structure for a fully implicit system

Source

pub fn compute_index<FFunc, GFunc>( &mut self, t: F, x: ArrayView1<'_, F>, y: ArrayView1<'_, F>, f: &FFunc, g: &GFunc, ) -> IntegrateResult<DAEIndex>
where FFunc: Fn(F, ArrayView1<'_, F>, ArrayView1<'_, F>) -> Array1<F>, GFunc: Fn(F, ArrayView1<'_, F>, ArrayView1<'_, F>) -> Array1<F>,

Compute the index of the DAE system

Trait Implementations§

Source §

impl<F: Clone + Float + FromPrimitive + Debug + ScalarOperand + AddAssign + SubAssign + MulAssign + DivAssign + Display + LowerExp + Sum + IntegrateFloat> Clone for DAEStructure<F>

Source §

fn clone(&self) -> DAEStructure<F>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<F: Debug + Float + FromPrimitive + Debug + ScalarOperand + AddAssign + SubAssign + MulAssign + DivAssign + Display + LowerExp + Sum + IntegrateFloat> Debug for DAEStructure<F>

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<F: Float + FromPrimitive + Debug + ScalarOperand + AddAssign + SubAssign + MulAssign + DivAssign + Display + LowerExp + Sum + IntegrateFloat> Default for DAEStructure<F>

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<F> UnwindSafe for DAEStructure<F>
where F: RefUnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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

Source §