Engee documentation

lcladder

Creates an LC ladder chain object.

Library

EngeeRF

Syntax

Function call

  • lcobj = lcladder(top,L, C) — creates an LC ladder chain object lcobj and sets the properties Topology, Inductances and Capacitances using the values of the arguments top, L and C accordingly.

  • lcobj = lcladder(_, lcname) — creates an LC ladder chain object lcobj with a name lcname. Specify lcname after all other input arguments.

Arguments

Input arguments

# top — the type of topology of the LC ladder chain

+ "lowpasspi" | "lowpasstee" | "highpasspi" | "highpasstee" | "bandpasspi" | "bandpasstee" | "bandstoppi" | "bandstoptee"

Details

The type of topology of the LC ladder circuit, defined in one of the following ways:

  • "lowpasspi" — P-low pass filter;

  • "lowpasstee" — Low-pass T-filter;

  • "highpasspi" — P-high-pass filter;

  • "highpasstee" — High-pass T-filter;

  • "bandpasspi" — bandpass P-filter;

  • "bandpasstee" — bandpass T-filter;

  • "bandstoppi" — notch P-filter;

  • "bandstoptee" — notch T-filter.

# L — inductance, Gn

+ the inductor object | the real scalar | two-element vector

Details

The value of the inductors in the LC ladder circuit in Gn, set as an inductor object inductor, a real scalar or a two-element vector.

# C — capacity, F

+ the capacitor object | the real scalar | two-element vector

Details

The value of the capacitances in the LC ladder circuit in F, set as a capacitor object capacitor, a real scalar or a two-element vector.

# lcname is the name of the LC ladder chain object

+ "lcfilt" (default) | character vector

Details

The name of the LC ladder chain object, specified as a vector of characters.

Output arguments

# lcobj — LC ladder chain object

+ scalar descriptor object

Details

The object of the LC ladder chain. The LC ladder chain object contains the following properties:

  • Topology — the type of topology of the LC ladder chain, for example "lowpasspi".

  • Inductances — inductors in the LC ladder circuit in Gn, specified as an inductor object inductor, a real scalar or a two-element vector, for example 1e−9.

  • Capacitances — capacitances in the ladder LC circuit in F, specified as a capacitor object capacitor, a real scalar or a two-element vector, for example 2e−12.

  • Name — the name of the LC ladder chain in the form of a symbolic vector, for example "lcfilter".

  • NumPorts — the number of ports in the LC ladder circuit object as a positive scalar value. This property is read-only.

  • Terminals — terminals of the ladder LC circuit in the form of a vector of cells. This property is read-only.

  • ParentPath — the full path to the circuit to which the LC ladder circuit object belongs, in the form of a symbolic vector. This path appears only after adding a resistor to the circuit.

  • ParentNodes — nodes of the parent circuit to which the terminals of the ladder LC circuit are connected, in the form of a vector of integers. This property appears only after adding a resistor to the circuit.

Examples

Creating a ladder LC circuit of a low-pass filter

Details

Let’s create a ladder LC circuit of a low-pass P-filter and deduce its properties.

import EngeeRF:lcladder, add, setports

L = 3.18e-8
C = [6.37e-12, 6.37e-12]
lpp = lcladder("lowpasspi",L,C)
lcladder(Inductances = 3.18e-8, Capacitances = Union{Nothing, Float64}[6.37e-12, 6.37e-12], Elements = Vector{EngeeRF.DomainRF.DomainObjectRF}, Ports = ("p1", "p2"), Nodes = [1, 2, 3], Parent = nothing, ParentNodes = Int64[], ParentPath = "", NumPorts = 2, Terminals = ("p1+", "p2+", "p1-", "p2-"), Name = "LCL", Topology = "lowpasspi", LadderCircuit = circuit)

Let’s add the created LC ladder circuit to the circuit and output its properties.

c = circuit("example")
add(c,[1 2 0 0],lpp)
setports(c,[1 0],[2 0])
circuit(ElementNames = ("LCL",), Terminals = ("p1+", "p2+", "p1-", "p2-"), Name = "example", Elements = Vector{EngeeRF.DomainRF.DomainObjectRF}, Ports = ("p1", "p2"), Nodes = [0, 1, 2], TerminalNodes = [1, 2, 0, 0])