Dyad

Appearance

PulseTest.md

PulseTest ​

Generates a pulse signal with configurable parameters and integrates it.

This test component demonstrates the connection of a Pulse signal generator to an Integrator block, showing how the integrated value of a periodic pulse signal evolves over time. The pulse signal alternates between two levels (offset and offset+amplitude) based on the duty cycle and period parameters. The resulting waveform is then integrated over time.

Usage ​

PulseTest()

Behavior ​

signal.y(t)=integrator.u(t)dintegrator.x(t)dt=integrator.kintegrator.u(t)integrator.y(t)=integrator.x(t)signal.y(t)=ifelse(t>signal.start_time,ifelse(t≤signal.start_time+signal.duty_cyclesignal.period,signal.amplitude,signal.offset),signal.offset)

Source ​

dyad
# Generates a pulse signal with configurable parameters and integrates it.
#
# This test component demonstrates the connection of a Pulse signal generator to an
# Integrator block, showing how the integrated value of a periodic pulse signal evolves
# over time. The pulse signal alternates between two levels (offset and offset+amplitude)
# based on the duty cycle and period parameters. The resulting waveform is then integrated
# over time.
test component PulseTest
  # Integrator that accumulates the pulse signal value over time
  integrator = Integrator()
  # Pulse signal generator with configurable amplitude, duty cycle, offset, period and start time
  signal = Pulse(amplitude=1.5, duty_cycle=0.5, offset=0.75, period=0.75, start_time=0.5)
relations
  # Connects the pulse signal output to the integrator input
  connect(signal.y, integrator.u)
metadata {
  "Dyad": {
    "tests": {
      "case1": {
        "stop": 3,
        "expect": {
          "initial": {"signal.y": 0.75},
          "signals": ["signal.y", "integrator.x"],
          "final": {"signal.y": 0.75, "integrator.x": 2.24999999}
        }
      }
    }
  }
}
end
Flattened Source
dyad
# Generates a pulse signal with configurable parameters and integrates it.
#
# This test component demonstrates the connection of a Pulse signal generator to an
# Integrator block, showing how the integrated value of a periodic pulse signal evolves
# over time. The pulse signal alternates between two levels (offset and offset+amplitude)
# based on the duty cycle and period parameters. The resulting waveform is then integrated
# over time.
test component PulseTest
  # Integrator that accumulates the pulse signal value over time
  integrator = Integrator()
  # Pulse signal generator with configurable amplitude, duty cycle, offset, period and start time
  signal = Pulse(amplitude=1.5, duty_cycle=0.5, offset=0.75, period=0.75, start_time=0.5)
relations
  # Connects the pulse signal output to the integrator input
  connect(signal.y, integrator.u)
metadata {
  "Dyad": {
    "tests": {
      "case1": {
        "stop": 3,
        "expect": {
          "initial": {"signal.y": 0.75},
          "signals": ["signal.y", "integrator.x"],
          "final": {"signal.y": 0.75, "integrator.x": 2.24999999}
        }
      }
    }
  }
}
end


Test Cases ​

This is setup code, that must be run before each test case.

julia
using BlockComponents
using ModelingToolkit, OrdinaryDiffEqDefault
using Plots
using CSV, DataFrames

snapshotsdir = joinpath(dirname(dirname(pathof(BlockComponents))), "test", "snapshots")
"/home/actions-runner-10/.julia/packages/BlockComponents/77kIK/test/snapshots"

Test Case case1 ​

julia
@mtkbuild model_case1 = PulseTest()
u0_case1 = []
prob_case1 = ODEProblem(model_case1, u0_case1, (0, 3))
sol_case1 = solve(prob_case1)
retcode: Success
Interpolation: 3rd order Hermite
t: 7-element Vector{Float64}:
 0.0
 9.999999999999999e-5
 0.0010999999999999998
 0.011099999999999997
 0.11109999999999996
 1.1110999999999995
 3.0
u: 7-element Vector{Vector{Float64}}:
 [0.0]
 [7.499999999999998e-5]
 [0.0008249999999999997]
 [0.008324999999999996]
 [0.08332499999999995]
 [0.8333249999999995]
 [2.2499999999999996]
julia
df_case1 = DataFrame(:t => sol_case1[:t], :actual => sol_case1[model_case1.signal.y])
dfr_case1 = try CSV.read(joinpath(snapshotsdir, "PulseTest_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
scatter!(plt, [df_case1.t[1]], [0.75], label="Initial Condition for `signal.y`")
scatter!(plt, [df_case1.t[end]], [0.75], label="Final Condition for `signal.y`")

plt

julia
df_case1 = DataFrame(:t => sol_case1[:t], :actual => sol_case1[model_case1.integrator.x])
dfr_case1 = try CSV.read(joinpath(snapshotsdir, "PulseTest_case1_sig1.ref"), DataFrame); catch e; nothing; end
plt = plot(sol_case1, idxs=[model_case1.integrator.x], width=2, label="Actual value of integrator.x")
if !isnothing(dfr_case1)
  scatter!(plt, dfr_case1.t, dfr_case1.expected, mc=:red, ms=3, label="Expected value of integrator.x")
end
scatter!(plt, [df_case1.t[end]], [2.24999999], label="Final Condition for `integrator.x`")

plt