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 ​

BlockComponents.PulseTest()

Behavior ​

julia
using BlockComponents #hide
using ModelingToolkit #hide
@named sys = BlockComponents.PulseTest() #hide
full_equations(sys) #hide
<< @example-block not executed in draft mode >>

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() {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 155, "y1": 20, "x2": 255, "y2": 120, "rot": 0}
      }
    }
  }
  "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) {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 20, "y1": 20, "x2": 120, "y2": 120, "rot": 0}
      }
    }
  }
relations
  "Connects the pulse signal output to the integrator input"
  connect(signal.y, integrator.u) {"Dyad": {"edges": [{"S": 1, "M": [], "E": 2}], "renderStyle": "standard"}}
metadata {
  "Dyad": {
    "icons": {"default": "dyad://BlockComponents/Example.svg"},
    "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() {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 155, "y1": 20, "x2": 255, "y2": 120, "rot": 0}
      }
    }
  }
  "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) {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 20, "y1": 20, "x2": 120, "y2": 120, "rot": 0}
      }
    }
  }
relations
  "Connects the pulse signal output to the integrator input"
  connect(signal.y, integrator.u) {"Dyad": {"edges": [{"S": 1, "M": [], "E": 2}], "renderStyle": "standard"}}
metadata {
  "Dyad": {
    "icons": {"default": "dyad://BlockComponents/Example.svg"},
    "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 ​

julia
using BlockComponents
using DyadInterface: TransientAnalysis, rebuild_sol
using ModelingToolkit: toggle_namespacing, get_defaults, @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 = PulseTest()
model_case1 = toggle_namespacing(model_case1, false)

model_case1 = toggle_namespacing(model_case1, true)
result_case1 = TransientAnalysis(; model = model_case1, alg = "auto", start = 0e+0, stop = 3e+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, "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`")
<< @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.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`")
<< @setup-block not executed in draft mode >>
julia
plt
<< @example-block not executed in draft mode >>