Dyad

Appearance

LIBRARY
Sources.Tests.LogFrequencySweep.md

Sources.Tests.LogFrequencySweep ​

Test that validates logarithmic frequency sweep behavior.

This component creates a test setup for validating the LogFrequencySweep block by connecting its output to a Terminator. The sweep starts at wMin=1 and ends at wMax=100 over a duration of 3 seconds. The output ramps logarithmically from 1 to 100, meaning the logarithm of the output performs a linear ramp from log10(1)=0 to log10(100)=2.

Usage ​

BlockComponents.Sources.Tests.LogFrequencySweep()

Behavior ​

julia
using BlockComponents #hide
using ModelingToolkit #hide
@named sys = BlockComponents.Sources.Tests.LogFrequencySweep() #hide
let eqs = full_equations(sys); Base.length(eqs) > 25 ? nothing : eqs end #hide
<< @example-block not executed in draft mode >>

Source ​

dyad
"""
Test that validates logarithmic frequency sweep behavior.

This component creates a test setup for validating the `LogFrequencySweep` block by
connecting its output to a `Terminator`. The sweep starts at `wMin=1` and ends at
`wMax=100` over a `duration` of 3 seconds. The output ramps logarithmically from 1
to 100, meaning the logarithm of the output performs a linear ramp from `log10(1)=0`
to `log10(100)=2`.
"""
test component LogFrequencySweep
  "Terminates a signal connection without passing it further"
  terminator = BlockComponents.Routing.Terminator() {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 155, "y1": 20, "x2": 255, "y2": 120, "rot": 0}
      }
    }
  }
  "Generates a logarithmic frequency sweep from wMin to wMax"
  signal = BlockComponents.Sources.LogFrequencySweep(wMin = 1, wMax = 100, startTime = 0, duration = 3) {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 20, "y1": 20, "x2": 120, "y2": 120, "rot": 0}
      }
    }
  }
relations
  "Connects the sweep output to the terminator input"
  connect(signal.y, terminator.u) {"Dyad": {"edges": [{"S": 1, "M": [], "E": 2}], "renderStyle": "standard"}}
metadata {
  "Dyad": {
    "icons": {"default": "dyad://BlockComponents/Example.svg"},
    "tests": {"case1": {"stop": 4, "expect": {"signals": ["signal.y", "terminator.u"]}}}
  }
}
end
Flattened Source
dyad
"""
Test that validates logarithmic frequency sweep behavior.

This component creates a test setup for validating the `LogFrequencySweep` block by
connecting its output to a `Terminator`. The sweep starts at `wMin=1` and ends at
`wMax=100` over a `duration` of 3 seconds. The output ramps logarithmically from 1
to 100, meaning the logarithm of the output performs a linear ramp from `log10(1)=0`
to `log10(100)=2`.
"""
test component LogFrequencySweep
  "Terminates a signal connection without passing it further"
  terminator = BlockComponents.Routing.Terminator() {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 155, "y1": 20, "x2": 255, "y2": 120, "rot": 0}
      }
    }
  }
  "Generates a logarithmic frequency sweep from wMin to wMax"
  signal = BlockComponents.Sources.LogFrequencySweep(wMin = 1, wMax = 100, startTime = 0, duration = 3) {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 20, "y1": 20, "x2": 120, "y2": 120, "rot": 0}
      }
    }
  }
relations
  "Connects the sweep output to the terminator input"
  connect(signal.y, terminator.u) {"Dyad": {"edges": [{"S": 1, "M": [], "E": 2}], "renderStyle": "standard"}}
metadata {
  "Dyad": {
    "icons": {"default": "dyad://BlockComponents/Example.svg"},
    "tests": {"case1": {"stop": 4, "expect": {"signals": ["signal.y", "terminator.u"]}}}
  }
}
end


Test Cases ​

julia
using BlockComponents
using DyadInterface: TransientAnalysis, rebuild_sol, ODEAlg
using ModelingToolkit: toggle_namespacing, get_initial_conditions, @named
using CSV, DataFrames, Plots

snapshotsdir = joinpath(dirname(dirname(pathof(BlockComponents))), "test", "snapshots")
<< @setup-block not executed in draft mode >>

Test Case case1 ​

julia
@named model_case1 = BlockComponents.Sources.Tests.LogFrequencySweep()
model_case1 = toggle_namespacing(model_case1, false)

model_case1 = toggle_namespacing(model_case1, true)
result_case1 = TransientAnalysis(; model = model_case1, alg = ODEAlg.Auto(), start = 0e+0, stop = 4e+0, abstol=1e-6, reltol=1e-6)
sol_case1 = rebuild_sol(result_case1)
<< @setup-block not executed in draft mode >>
julia
df_case1 = DataFrame(:t => sol_case1[:t], :actual => sol_case1[model_case1.signal.y])
dfr_case1 = try CSV.read(joinpath(snapshotsdir, "BlockComponents.Sources.Tests.LogFrequencySweep_case1_sig0.ref"), DataFrame); catch e; nothing; end
plt = plot(sol_case1, idxs=[model_case1.signal.y], width=2, label="Actual value of signal.y")
if !isnothing(dfr_case1)
  scatter!(plt, dfr_case1.t, dfr_case1.expected, mc=:red, ms=3, label="Expected value of signal.y")
end
<< @setup-block not executed in draft mode >>
julia
plt
<< @example-block not executed in draft mode >>
julia
df_case1 = DataFrame(:t => sol_case1[:t], :actual => sol_case1[model_case1.terminator.u])
dfr_case1 = try CSV.read(joinpath(snapshotsdir, "BlockComponents.Sources.Tests.LogFrequencySweep_case1_sig1.ref"), DataFrame); catch e; nothing; end
plt = plot(sol_case1, idxs=[model_case1.terminator.u], width=2, label="Actual value of terminator.u")
if !isnothing(dfr_case1)
  scatter!(plt, dfr_case1.t, dfr_case1.expected, mc=:red, ms=3, label="Expected value of terminator.u")
end
<< @setup-block not executed in draft mode >>
julia
plt
<< @example-block not executed in draft mode >>