Struct Spectre

pub struct Spectre {}

Spectre simulator global configuration.

Implementations

impl Spectre

pub fn escape_identifier(node_name: &str) -> String

Escapes the given identifier to be Spectre-compatible.

pub fn instance_path( lib: &Library<Spectre>, conv: &NetlistLibConversion, path: &InstancePath, ) -> String

Converts a scir::InstancePath to a Spectre path string corresponding to the associated instance.

pub fn node_voltage_path( lib: &Library<Spectre>, conv: &NetlistLibConversion, path: &SliceOnePath, ) -> String

Converts a SliceOnePath to a Spectre path string corresponding to the associated node voltage.

pub fn node_current_path( lib: &Library<Spectre>, conv: &NetlistLibConversion, path: &SliceOnePath, ) -> String

Converts a SliceOnePath to a Spectre path string corresponding to the associated terminal current.

Trait Implementations

impl Clone for Spectre

fn clone(&self) -> Spectre

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConvertibleNetlister<Spectre> for Spectre

type Error = Error

The error type returned when writing out a SCIR netlist.

type Options<'a> = NetlistOptions<'a>

The netlist options type.

fn write_scir_netlist<W: Write>( &self, lib: &Library<Spectre>, out: &mut W, opts: Self::Options<'_>, ) -> Result<NetlistLibConversion, Self::Error>

Writes a netlist of a SCIR library to the provided output stream.

fn write_scir_netlist_to_file( &self, lib: &Library<S>, path: impl AsRef<Path>, opts: Self::Options<'_>, ) -> Result<NetlistLibConversion, Self::Error>

Writes a netlist of a SCIR library to a file at the given path.

impl Debug for Spectre

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

Formats the value using the given formatter.

impl Default for Spectre

fn default() -> Spectre

Returns the “default value” for a type.

impl FromSchema<NoSchema> for Spectre

type Error = NoSchemaError

The conversion error type.

fn convert_primitive( _primitive: <NoSchema as Schema>::Primitive, ) -> Result<<Self as Schema>::Primitive, Self::Error>

Converts a primitive of the other schema to a primitive of this schema.

fn convert_instance( _instance: &mut Instance, _primitive: &<NoSchema as Schema>::Primitive, ) -> Result<(), Self::Error>

Converts an instance from the other schema to a new instance based on its associated primitive.

impl FromSchema<Spice> for Spectre

type Error = SpectreConvError

The conversion error type.

fn convert_primitive( primitive: <Spice as Schema>::Primitive, ) -> Result<<Self as Schema>::Primitive, Self::Error>

Converts a primitive of the other schema to a primitive of this schema.

fn convert_instance( _instance: &mut Instance, _primitive: &<Spice as Schema>::Primitive, ) -> Result<(), Self::Error>

Converts an instance from the other schema to a new instance based on its associated primitive.

impl HasSpiceLikeNetlist for Spectre

fn write_prelude<W: Write>( &self, out: &mut W, lib: &Library<Spectre>, ) -> Result<()>

Writes a prelude to the beginning of the output stream.

fn write_include<W: Write>(&self, out: &mut W, include: &Include) -> Result<()>

Writes an include statement.

fn write_start_subckt<W: Write>( &self, out: &mut W, name: &ArcStr, ports: &[&SignalInfo], ) -> Result<()>

Writes a begin subcircuit statement.

fn write_end_subckt<W: Write>(&self, out: &mut W, name: &ArcStr) -> Result<()>

Writes an end subcircuit statement.

fn write_instance<W: Write>( &self, out: &mut W, name: &ArcStr, connections: Vec<ArcStr>, child: &ArcStr, ) -> Result<ArcStr>

Writes a SCIR instance.

fn write_primitive_inst<W: Write>( &self, out: &mut W, name: &ArcStr, connections: HashMap<ArcStr, Vec<ArcStr>>, primitive: &<Self as Schema>::Primitive, ) -> Result<ArcStr>

Writes a primitive instantiation.

fn write_slice<W: Write>( &self, out: &mut W, slice: Slice, info: &SignalInfo, ) -> Result<()>

Writes a slice.

fn write_postlude<W>( &self, out: &mut W, lib: &Library<Self>, ) -> Result<(), Error>

where W: Write,

Writes a postlude to the end of the output stream.

impl Installation for Spectre

fn post_install(&self, ctx: &mut ContextBuilder)

A post-installation hook for additional context modifications required by the installation.

impl Save<Spectre, Ac> for NestedNode

type SaveKey = VoltageSaveKey

The key type used to address the saved output within the analysis.

type Saved = Arc<Vec<Complex<f64>>>

The saved data associated with things object.

fn save( &self, ctx: &SimulationContext<Spectre>, opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, Ac>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<Ac as Analysis>::Output, key: &<Self as Save<Spectre, Ac>>::SaveKey, ) -> <Self as Save<Spectre, Ac>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl Save<Spectre, Ac> for NestedTerminal

type SaveKey = (VoltageSaveKey, CurrentSaveKey)

The key type used to address the saved output within the analysis.

type Saved = NestedTerminalOutput

The saved data associated with things object.

fn save( &self, ctx: &SimulationContext<Spectre>, opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, Ac>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<Ac as Analysis>::Output, key: &<Self as Save<Spectre, Ac>>::SaveKey, ) -> <Self as Save<Spectre, Ac>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl Save<Spectre, Ac> for RawNestedNode

type SaveKey = VoltageSaveKey

The key type used to address the saved output within the analysis.

type Saved = Arc<Vec<Complex<f64>>>

The saved data associated with things object.

fn save( &self, ctx: &SimulationContext<Spectre>, opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, Ac>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<Ac as Analysis>::Output, key: &<Self as Save<Spectre, Ac>>::SaveKey, ) -> <Self as Save<Spectre, Ac>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl Save<Spectre, Ac> for SaveFreq

type SaveKey = ()

The key type used to address the saved output within the analysis.

type Saved = Arc<Vec<f64>>

The saved data associated with things object.

fn save( &self, _ctx: &SimulationContext<Spectre>, _opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, Ac>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<Ac as Analysis>::Output, _key: &<Self as Save<Spectre, Ac>>::SaveKey, ) -> <Self as Save<Spectre, Ac>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl Save<Spectre, Ac> for SaveOutput

type SaveKey = ()

The key type used to address the saved output within the analysis.

type Saved = Output

The saved data associated with things object.

fn save( &self, _ctx: &SimulationContext<Spectre>, _opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, Ac>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<Ac as Analysis>::Output, _key: &<Self as Save<Spectre, Ac>>::SaveKey, ) -> <Self as Save<Spectre, Ac>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl Save<Spectre, DcOp> for NestedNode

type SaveKey = VoltageSaveKey

The key type used to address the saved output within the analysis.

type Saved = f64

The saved data associated with things object.

fn save( &self, ctx: &SimulationContext<Spectre>, opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, DcOp>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<DcOp as Analysis>::Output, key: &<Self as Save<Spectre, DcOp>>::SaveKey, ) -> <Self as Save<Spectre, DcOp>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl Save<Spectre, DcOp> for NestedTerminal

type SaveKey = (VoltageSaveKey, CurrentSaveKey)

The key type used to address the saved output within the analysis.

type Saved = NestedTerminalOutput

The saved data associated with things object.

fn save( &self, ctx: &SimulationContext<Spectre>, opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, DcOp>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<DcOp as Analysis>::Output, key: &<Self as Save<Spectre, DcOp>>::SaveKey, ) -> <Self as Save<Spectre, DcOp>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl Save<Spectre, DcOp> for RawNestedNode

type SaveKey = VoltageSaveKey

The key type used to address the saved output within the analysis.

type Saved = f64

The saved data associated with things object.

fn save( &self, ctx: &SimulationContext<Spectre>, opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, DcOp>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<DcOp as Analysis>::Output, key: &<Self as Save<Spectre, DcOp>>::SaveKey, ) -> <Self as Save<Spectre, DcOp>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl Save<Spectre, DcOp> for SaveOutput

type SaveKey = ()

The key type used to address the saved output within the analysis.

type Saved = OpOutput

The saved data associated with things object.

fn save( &self, _ctx: &SimulationContext<Spectre>, _opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, DcOp>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<DcOp as Analysis>::Output, _key: &<Self as Save<Spectre, DcOp>>::SaveKey, ) -> <Self as Save<Spectre, DcOp>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl<A: Analysis> Save<Spectre, MonteCarlo<A>> for NestedNode

where NestedNode: Save<Spectre, A>,

type SaveKey = <NestedNode as Save<Spectre, A>>::SaveKey

The key type used to address the saved output within the analysis.

type Saved = Vec<<NestedNode as Save<Spectre, A>>::Saved>

The saved data associated with things object.

fn save( &self, ctx: &SimulationContext<Spectre>, opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, MonteCarlo<A>>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<MonteCarlo<A> as Analysis>::Output, key: &<Self as Save<Spectre, MonteCarlo<A>>>::SaveKey, ) -> <Self as Save<Spectre, MonteCarlo<A>>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl<A: Analysis> Save<Spectre, MonteCarlo<A>> for NestedTerminal

where NestedTerminal: Save<Spectre, A>,

type SaveKey = <NestedTerminal as Save<Spectre, A>>::SaveKey

The key type used to address the saved output within the analysis.

type Saved = Vec<<NestedTerminal as Save<Spectre, A>>::Saved>

The saved data associated with things object.

fn save( &self, ctx: &SimulationContext<Spectre>, opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, MonteCarlo<A>>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<MonteCarlo<A> as Analysis>::Output, key: &<Self as Save<Spectre, MonteCarlo<A>>>::SaveKey, ) -> <Self as Save<Spectre, MonteCarlo<A>>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl<A: Analysis> Save<Spectre, MonteCarlo<A>> for RawNestedNode

where RawNestedNode: Save<Spectre, A>,

type SaveKey = <RawNestedNode as Save<Spectre, A>>::SaveKey

The key type used to address the saved output within the analysis.

type Saved = Vec<<RawNestedNode as Save<Spectre, A>>::Saved>

The saved data associated with things object.

fn save( &self, ctx: &SimulationContext<Spectre>, opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, MonteCarlo<A>>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<MonteCarlo<A> as Analysis>::Output, key: &<Self as Save<Spectre, MonteCarlo<A>>>::SaveKey, ) -> <Self as Save<Spectre, MonteCarlo<A>>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl Save<Spectre, Tran> for NestedNode

type SaveKey = VoltageSaveKey

The key type used to address the saved output within the analysis.

type Saved = OutputWaveform

The saved data associated with things object.

fn save( &self, ctx: &SimulationContext<Spectre>, opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, Tran>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<Tran as Analysis>::Output, key: &<Self as Save<Spectre, Tran>>::SaveKey, ) -> <Self as Save<Spectre, Tran>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl Save<Spectre, Tran> for NestedTerminal

type SaveKey = (VoltageSaveKey, CurrentSaveKey)

The key type used to address the saved output within the analysis.

type Saved = NestedTerminalOutput

The saved data associated with things object.

fn save( &self, ctx: &SimulationContext<Spectre>, opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, Tran>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<Tran as Analysis>::Output, key: &<Self as Save<Spectre, Tran>>::SaveKey, ) -> <Self as Save<Spectre, Tran>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl Save<Spectre, Tran> for RawNestedNode

type SaveKey = VoltageSaveKey

The key type used to address the saved output within the analysis.

type Saved = OutputWaveform

The saved data associated with things object.

fn save( &self, ctx: &SimulationContext<Spectre>, opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, Tran>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<Tran as Analysis>::Output, key: &<Self as Save<Spectre, Tran>>::SaveKey, ) -> <Self as Save<Spectre, Tran>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl Save<Spectre, Tran> for SaveOutput

type SaveKey = ()

The key type used to address the saved output within the analysis.

type Saved = Output

The saved data associated with things object.

fn save( &self, _ctx: &SimulationContext<Spectre>, _opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, Tran>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<Tran as Analysis>::Output, _key: &<Self as Save<Spectre, Tran>>::SaveKey, ) -> <Self as Save<Spectre, Tran>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl Save<Spectre, Tran> for SaveTime

type SaveKey = ()

The key type used to address the saved output within the analysis.

type Saved = Arc<Vec<f64>>

The saved data associated with things object.

fn save( &self, _ctx: &SimulationContext<Spectre>, _opts: &mut <Spectre as Simulator>::Options, ) -> <Self as Save<Spectre, Tran>>::SaveKey

Marks the given output for saving, returning a key that can be used to recover the output once the simulation is complete.

fn from_saved( output: &<Tran as Analysis>::Output, _key: &<Self as Save<Spectre, Tran>>::SaveKey, ) -> <Self as Save<Spectre, Tran>>::Saved

Recovers the desired simulation output from the analysis’s output.

impl Schema for Spectre

type Primitive = Primitive

A primitive used for storing arbitrary data that is opaque to SCIR.

impl SimOption<Spectre> for InitialCondition<&ConvertedNodePath, Voltage>

fn set_option( self, opts: &mut <Spectre as Simulator>::Options, _ctx: &SimulationContext<Spectre>, )

Modifies the simulator’s options to enable this option.

impl SimOption<Spectre> for InitialCondition<&NodePath, Voltage>

fn set_option( self, opts: &mut <Spectre as Simulator>::Options, ctx: &SimulationContext<Spectre>, )

Modifies the simulator’s options to enable this option.

impl SimOption<Spectre> for InitialCondition<&SliceOnePath, Voltage>

fn set_option( self, opts: &mut <Spectre as Simulator>::Options, _ctx: &SimulationContext<Spectre>, )

Modifies the simulator’s options to enable this option.

impl SimOption<Spectre> for InitialCondition<&String, Voltage>

fn set_option( self, opts: &mut <Spectre as Simulator>::Options, _ctx: &SimulationContext<Spectre>, )

Modifies the simulator’s options to enable this option.

impl SimOption<Spectre> for InitialCondition<&str, Voltage>

fn set_option( self, opts: &mut <Spectre as Simulator>::Options, _ctx: &SimulationContext<Spectre>, )

Modifies the simulator’s options to enable this option.

impl SimOption<Spectre> for InitialCondition<ArcStr, Voltage>

fn set_option( self, opts: &mut <Spectre as Simulator>::Options, _ctx: &SimulationContext<Spectre>, )

Modifies the simulator’s options to enable this option.

impl SimOption<Spectre> for InitialCondition<ConvertedNodePath, Voltage>

fn set_option( self, opts: &mut <Spectre as Simulator>::Options, ctx: &SimulationContext<Spectre>, )

Modifies the simulator’s options to enable this option.

impl SimOption<Spectre> for InitialCondition<NodePath, Voltage>

fn set_option( self, opts: &mut <Spectre as Simulator>::Options, ctx: &SimulationContext<Spectre>, )

Modifies the simulator’s options to enable this option.

impl SimOption<Spectre> for InitialCondition<SimSignal, Voltage>

fn set_option( self, opts: &mut <Spectre as Simulator>::Options, _ctx: &SimulationContext<Spectre>, )

Modifies the simulator’s options to enable this option.

impl SimOption<Spectre> for InitialCondition<SliceOnePath, Voltage>

fn set_option( self, opts: &mut <Spectre as Simulator>::Options, ctx: &SimulationContext<Spectre>, )

Modifies the simulator’s options to enable this option.

impl SimOption<Spectre> for InitialCondition<String, Voltage>

fn set_option( self, opts: &mut <Spectre as Simulator>::Options, _ctx: &SimulationContext<Spectre>, )

Modifies the simulator’s options to enable this option.

impl SimOption<Spectre> for Temperature

fn set_option( self, opts: &mut <Spectre as Simulator>::Options, _ctx: &SimulationContext<Spectre>, )

Modifies the simulator’s options to enable this option.

impl Simulator for Spectre

type Schema = Spectre

The schema that this simulator uses.

type Input = Input

The input type this simulator accepts.

type Options = Options

Options shared across all analyses for a given simulator run.

type Output = Output

The output type produced by this simulator.

type Error = Error

The error type returned by the simulator.

fn simulate_inputs( &self, config: &SimulationContext<Self>, options: Self::Options, input: Vec<Self::Input>, ) -> Result<Vec<Self::Output>>

Simulates the given set of analyses.

fn simulate<A>( &self, ctx: &SimulationContext<Self>, options: Self::Options, input: A, ) -> Result<<A as Analysis>::Output, Self::Error>

where A: SupportedBy<Self>, Self: Sized,

Simulates the given, possibly composite, analysis.

impl SupportedBy<Spectre> for Ac

fn into_input(self, inputs: &mut Vec<<Spectre as Simulator>::Input>)

Convert the analysis into inputs accepted by this simulator.

fn from_output( outputs: &mut impl Iterator<Item = <Spectre as Simulator>::Output>, ) -> <Self as Analysis>::Output

Convert this simulator’s outputs to the analysis’s expected output.

impl SupportedBy<Spectre> for DcOp

fn into_input(self, inputs: &mut Vec<<Spectre as Simulator>::Input>)

Convert the analysis into inputs accepted by this simulator.

fn from_output( outputs: &mut impl Iterator<Item = <Spectre as Simulator>::Output>, ) -> <Self as Analysis>::Output

Convert this simulator’s outputs to the analysis’s expected output.

impl<A: SupportedBy<Spectre>> SupportedBy<Spectre> for MonteCarlo<A>

fn into_input(self, inputs: &mut Vec<<Spectre as Simulator>::Input>)

Convert the analysis into inputs accepted by this simulator.

fn from_output( outputs: &mut impl Iterator<Item = <Spectre as Simulator>::Output>, ) -> <Self as Analysis>::Output

Convert this simulator’s outputs to the analysis’s expected output.

impl SupportedBy<Spectre> for Tran

fn into_input(self, inputs: &mut Vec<<Spectre as Simulator>::Input>)

Convert the analysis into inputs accepted by this simulator.

fn from_output( outputs: &mut impl Iterator<Item = <Spectre as Simulator>::Output>, ) -> <Self as Analysis>::Output

Convert this simulator’s outputs to the analysis’s expected output.