module equation_builder.API

Table of Contents generated with DocToc

• Module: equation_builder
  • equation_builder
    • Requires
    • Namespaces
    • Type Definitions
      • builder
      • equation
      • getEquation() → {module:equation_builder.equation}
      • stamp(value) → {Object}

Module: equation_builder

equation_builder

Create an equation to describe a circuit.

Source:

• equation_builder.js , lineno 3

Requires

• module:matrixy
• module:chai

Namespaces

stamp

Type Definitions

builder

Type:

• Object

Properties:

Name	Type	Description
stamp	module:equation_builder.stamp
getEquation	module:equation_builder.getEquation

Source:

• equation_builder.js , lineno 49

equation

Type:

• Object

Properties:

Name	Type	Description
nodalAdmittances	external:Matrix
inputs	external:Matrix

Source:

• equation_builder.js , lineno 42

getEquation() → {module:equation_builder.equation}

Source:

• equation_builder.js , lineno 56

Returns:

Type

module:equation_builder.equation

stamp(value) → {Object}

Stamp an element into the circuit equation.

Parameters:

Name	Type	Description
value	Number	Value to stamp.

Source:

• equation_builder.js , lineno 62

Returns:

Choice of units to stamp.

Type

Object

Examples

# Stamp a 5 ohm resistor between nodes 1 and 2
stamp(5).ohms.between(1, 2)

# Stamp 5 volts from node 1 to node 2
stamp(5).volts.from(1).to(2)

# Stamp a Voltage-Controlled-Current-Source (VCCS)
stamp.a.gain.of(10).multiplying.a.voltage.from(1).to(2)
.controlling.a.currentSource.from(2).to(3)

Generated with wicked.