rspice 0.1.0

Pure-Rust circuit simulation backend
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

use crate::ConnectionRef;
use crate::EquationRef;
use crate::NetRef;
use crate::TransientMatrix;
use crate::TransientVector;

/// Component that directly interacts with the simulator.
///
/// You may implement this trait to add new fundamental
/// components that are not equivalent to a circuit made of
/// existing ones.
///
/// Implementors of this trait should not provide any constructor,
/// but instead a `create(&mut Circuit, NetRef, NetRef, ...)` method
/// that takes a circuit, an appropriate number of net references
/// and any required configuration values, and calls
/// [circuit.crateBasicComponent()](crate::Circuit::createBasicComponent) directly.
pub trait BasicComponent {
    /// Initialize component with information it needs to interact with simulation matrices.
    fn initCircuit(
        &mut self,
        nets: Vec<NetRef>,
        connections: Vec<ConnectionRef>,
        equations: Vec<EquationRef>,
    );

    /// Initialize component and matrix for transient simulation.
    fn initTransient(&mut self, matrix: &mut TransientMatrix);

    /// Update component and matrix every time step during transient simulation.
    fn updateTransient(
        &mut self,
        matrix: &mut TransientMatrix,
        vector: &TransientVector,
        t: f64,
        step: f64,
    ) {
    }
}