Dyad

Appearance

ContinuousClockTest.md

ContinuousClockTest ​

Test that evaluates a continuous clock signal integrated over time.

This test component connects a continuous clock signal to an integrator to validate the clock's behavior. The continuous clock starts at time 0.5 with an offset of 1.0, generating a signal that increases linearly with time (y = t + offset when t ≥ start_time). The integrator accumulates this signal, resulting in a quadratic response. The test verifies both the clock output and the integrated value against expected results at t=5.

Usage ​

BlockComponents.ContinuousClockTest()

Behavior ​

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

Source ​

dyad
"""
Test that evaluates a continuous clock signal integrated over time.

This test component connects a continuous clock signal to an integrator to validate the
clock's behavior. The continuous clock starts at time 0.5 with an offset of 1.0, generating
a signal that increases linearly with time (y = t + offset when t ≥ start_time). The integrator
accumulates this signal, resulting in a quadratic response. The test verifies both the clock
output and the integrated value against expected results at t=5.
"""
test component ContinuousClockTest
  "Integrator that accumulates the clock signal"
  integrator = Integrator() {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 150, "y1": 20, "x2": 250, "y2": 120, "rot": 0}
      }
    }
  }
  "Continuous clock with 0.5 start time and 1.0 offset"
  signal = ContinuousClock(start_time = 0.5, offset = 1.0) {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 20, "y1": 20, "x2": 120, "y2": 120, "rot": 0}
      }
    }
  }
relations
  "Connects the clock 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": 5,
        "atol": {"integrator.x": 0.001},
        "expect": {
          "initial": {"signal.y": 1},
          "signals": ["signal.y", "integrator.x"],
          "final": {"signal.y": 5.5, "integrator.x": 15.125}
        }
      }
    }
  }
}
end
Flattened Source
dyad
"""
Test that evaluates a continuous clock signal integrated over time.

This test component connects a continuous clock signal to an integrator to validate the
clock's behavior. The continuous clock starts at time 0.5 with an offset of 1.0, generating
a signal that increases linearly with time (y = t + offset when t ≥ start_time). The integrator
accumulates this signal, resulting in a quadratic response. The test verifies both the clock
output and the integrated value against expected results at t=5.
"""
test component ContinuousClockTest
  "Integrator that accumulates the clock signal"
  integrator = Integrator() {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 150, "y1": 20, "x2": 250, "y2": 120, "rot": 0}
      }
    }
  }
  "Continuous clock with 0.5 start time and 1.0 offset"
  signal = ContinuousClock(start_time = 0.5, offset = 1.0) {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 20, "y1": 20, "x2": 120, "y2": 120, "rot": 0}
      }
    }
  }
relations
  "Connects the clock 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": 5,
        "atol": {"integrator.x": 0.001},
        "expect": {
          "initial": {"signal.y": 1},
          "signals": ["signal.y", "integrator.x"],
          "final": {"signal.y": 5.5, "integrator.x": 15.125}
        }
      }
    }
  }
}
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 = ContinuousClockTest()
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 = 5e+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, "ContinuousClockTest_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]], [1], label="Initial Condition for `signal.y`")
scatter!(plt, [df_case1.t[end]], [5.5], 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, "ContinuousClockTest_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]], [15.125], label="Final Condition for `integrator.x`")
<< @setup-block not executed in draft mode >>
julia
plt
<< @example-block not executed in draft mode >>