Branch

class scqubits.core.symbolic_circuit_graph.Branch(n_i, n_f, branch_type, parameters, index=None, aux_params={})[source]

Class describing a circuit branch, used in the Circuit class.

Parameters:
  • n_i (Node) – initial Node of the branch

  • n_f (Node) – final Node of the branch

  • branch_type (str) – is the type of this Branch, example “C”, “JJ” or “L”

  • parameters (List[Union[float, Symbol, int]]) – list of parameters for the branch, namely for capacitance: [EC]; for inductance: [10]; for Josephson Junction: [EJ, 1]

  • aux_params (Dict[Symbol, float]) – Dictionary of auxiliary parameters which map a symbol from the input file a numeric parameter.

  • index (int | None)

Examples

Branch(“C”, Node(1, 0), Node(2, 0)) is a capacitive branch connecting the nodes with indices 0 and 1.

Methods

Branch.__init__(n_i, n_f, branch_type, ...)

Branch.common_node(branch)

Returns the common nodes between self and the branch given as input.

Branch.is_connected(branch)

Returns a boolean indicating whether the current branch is connected to the given branch

Branch.node_ids()

Returns the indices of the nodes connected by the branch.

common_node(branch)[source]

Returns the common nodes between self and the branch given as input.

Return type:

Set[Node]

is_connected(branch)[source]

Returns a boolean indicating whether the current branch is connected to the given branch

Return type:

bool

node_ids()[source]

Returns the indices of the nodes connected by the branch.

Return type:

Tuple[int, int]