Struct Simulator 

pub struct Simulator<S> {
    pub circuit: Circuit,
    pub simulate: S,
}

Fields

circuit: Circuit

simulate: S

Implementations

impl<S: Simulate> Simulator<S>

pub fn new(circuit: Circuit, simulate: S) -> Self

pub fn run_op(&mut self) -> Result<OpAnalysis, S::Err>

Examples found in repository

examples/voltage_current_divider.rs (line 13)

fn main_result() -> Result<(), Box<dyn std::error::Error>> {
    let mut circuit = Circuit::new("Voltage Divider");
    circuit.add_dc_voltage("input", "1", "0", u!(10 V));
    circuit.add_resistor("1", "1", "2", u!(2 kΩ));
    circuit.add_resistor("2", "2", "0", u!(1 kΩ));

    let simulate = NgSpiceShared::default()?;
    let mut simulator = circuit.simulator(simulate);
    let analysis = simulator.run_op()?;

    for (name, voltage) in analysis.nodes.iter() {
        println!("Node: {}: {:.3}", name, voltage);
    }

    Ok(())
}

examples/thévenin_representation.rs (line 13)

fn main_result() -> Result<(), Box<dyn std::error::Error>> {
    let mut circuit = Circuit::new("Thévenin Representation");
    circuit.add_dc_voltage("input", "1", "0", u!(10 V));
    circuit.add_resistor("generator", "1", "load", u!(10 Ω));
    circuit.add_resistor("load", "load", "0", u!(1 kΩ));

    let simulate = NgSpiceShared::default()?;
    let mut simulator = circuit.simulator(simulate);
    let analysis = simulator.run_op()?;

    let node_a = analysis.get_node("load").unwrap();
    println!("Node {}: {}", "load", node_a);

    Ok(())
}

examples/resistor_bridge.rs (line 17)

fn main_result() -> Result<(), Box<dyn std::error::Error>> {
    let mut circuit = Circuit::new("Resistor Bridge");

    circuit.add_dc_voltage("input", "1", "0", u!(10 V));
    circuit.add_resistor("1", "1", "2", u!(2 kΩ));
    circuit.add_resistor("2", "1", "3", u!(1 kΩ));
    circuit.add_resistor("3", "2", "0", u!(1 kΩ));
    circuit.add_resistor("4", "3", "0", u!(2 kΩ));
    circuit.add_resistor("5", "3", "2", u!(2 kΩ));

    let simulate = NgSpiceShared::default()?;
    let mut simulator = circuit.simulator(simulate);
    let analysis = simulator.run_op()?;

    for (name, node) in analysis.nodes.iter() {
        println!("Node {}: {}", name, node)
    }

    Ok(())
}

examples/millman_theorem.rs (line 24)

fn main_result() -> Result<(), Box<dyn std::error::Error>> {
    let mut circuit = Circuit::new("Millman's theorem");
    let number_of_branches = 3;
    for i in 1..number_of_branches+1 {
        circuit.add_dc_voltage(
            format!("input{}", i), 
            format!("{}", i), 
            "0", 
            u!(i V),
        );
        circuit.add_resistor(
            format!("{}", i), 
            format!("{}", i), 
            "A",
            u!(i kΩ));
    }

    let simulate = NgSpiceShared::default()?;
    let mut simulator = circuit.simulator(simulate);
    let analysis = simulator.run_op()?;

    let node_a = analysis.get_node("A").unwrap();
    println!("Node {}: {}", "A", node_a);

    Ok(())
}

pub fn run_tran( &mut self, command: &TranCommand, ) -> Result<TranAnalysis, S::Err>

Examples found in repository

examples/transient_sin.rs (line 17)

fn main_result() -> Result<(), Box<dyn std::error::Error>> {
    let mut circuit = Circuit::new("Transient sin");
    
    circuit.add_sine_voltage("input", "in", "0", SineVoltage::sin(u!(1 V), u!(100 Hz)));
    circuit.add_resistor("1", "in", "1", u!(3 kΩ));
    circuit.add_resistor("2", "1", "0", u!(1 kΩ));

    let simulate = NgSpiceShared::default()?;
    let mut simulator = circuit.simulator(simulate);
    let command = TranCommandBuilder::default()
        .t_stop(u!(0.02 s))
        .t_step(u!(1 us))
        .build().unwrap();
    let analysis = simulator.run_tran(&command)?;

    analysis.draw_nodes(&Drawer::default(), &["in"], "./images/transient-sin-nodes.png")?;
    analysis.draw_all_branchs(&Drawer::default(), "./images/transient-sin-branchs.png")?;

    Ok(())
}

examples/ac_coupled_amplifier.rs (line 32)

fn main_result() -> Result<(), Box<dyn std::error::Error>> {
    let mut circuit = Circuit::new("AC Coupled Amplifier");
    
    circuit.add_dc_voltage("power", "5", "0", u!(15 V));
    let sine = SineVoltage::sin(u!(0.5 V), u!(1 kHz));
    let period = sine.period();
    circuit.add_sine_voltage("in", "in", "0", sine);
    circuit.add_capacitor("1", "in", "2", u!(10 uF));
    circuit.add_resistor("1", "5", "2", u!(100 kΩ));
    circuit.add_resistor("2", "2", "0", u!(20 kΩ));
    circuit.add_resistor("C", "5", "4", u!(10 kΩ));
    circuit.add_bjt("1", "4", "2", "3", "bjt");
    let mut model = Model::npn("bjt");
    model.parameter("bf", 80.0);
    model.parameter("cjc", num!(5 p));
    model.parameter("rb", 100);
    circuit.add_model(model);
    circuit.add_resistor("E", "3", "0", u!(2 kΩ));
    circuit.add_capacitor("2", "4", "out", u!(10 uF));
    circuit.add_resistor("Load", "out", "0", u!(1 kΩ));

    let simulate = NgSpiceShared::default()?;
    let mut simulator = circuit.simulator(simulate);
    let command = TranCommandBuilder::default()
        .t_stop(2. * period)
        .t_step(u!(5 us))
        .build().unwrap();
    let analysis = simulator.run_tran(&command)?;

    analysis.draw_nodes(&Drawer::default(), &["in", "out"], "./images/ac-coupled-amplifier-nodes.png")?;
    analysis.draw_all_branchs(&Drawer::default(), "./images/ac-coupled-amplifier-branchs.png")?;

    Ok(())
}

pub fn run_dc_voltage( &mut self, command: &DcCommand, ) -> Result<DcVoltageAnalysis, S::Err>

Examples found in repository

examples/dc-sweep.rs (line 21)

fn main_result() -> Result<(), Box<dyn std::error::Error>> {
    let mut cir = Circuit::new("DC Sweep");
    cir.add_dc_voltage("1", "in", "0", num!(0.));
    cir.add_resistor("1", "in", "out", num!(2 k));
    cir.add_resistor("2", "out", "0", num!(1 k));
    
    let shared = NgSpiceShared::default()?;
    let mut simulator = cir.simulator(shared);
    
    let command = DcCommandBuilder::default()
        .src_name("V1")
        .start(num!(0.))
        .stop(num!(5.))
        .step(num!(0.1))
        .build().unwrap();
    
    let analysis = simulator.run_dc_voltage(&command)?;
    println!("{}", analysis.get_voltage_at("out", u!(200 uV)).unwrap());

    analysis.draw_all_branchs(&Drawer::default(), "./images/dc-sweep-branchs.png")?;
    analysis.draw_all_nodes(&Drawer::default(), "./images/dc-sweep-nodes.png")?;

    Ok(())
}

pub fn run_ac(&mut self, command: &AcCommand) -> Result<AcAnalysis, S::Err>

Examples found in repository

examples/low-pass_rc_filter.rs (line 14)

fn main_result() -> Result<(), Box<dyn std::error::Error>> {
    let mut circuit = Circuit::new("Low-Pass RC Filter");
    
    circuit.add_ac_voltage("input", "in", "0", 1., 0.);
    circuit.add_resistor("1", "in", "out", u!(1 kΩ));
    circuit.add_capacitor("1", "out", "0", u!(1 uF));

    let simulate = NgSpiceShared::default()?;
    let mut simulator = circuit.simulator(simulate);
    let analysis = simulator.run_ac(&AcCommand::dec(10, u!(1 Hz), u!(1 MHz)))?;
    
    let mut drawer = Drawer::default();
    drawer.height = 360;
    analysis.draw_gain(&drawer, "in", "out", "./images/low-pass_rc_filter-gain.png")?;
    analysis.draw_phase(&drawer, "in", "out", "./images/low-pass_rc_filter-phase.png")?;
    
    Ok(())
}

Trait Implementations

impl<S: Debug> Debug for Simulator<S>

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

Formats the value using the given formatter.