Dyad

Appearance

StepTest.md

StepTest ​

Test that validates step response behavior by connecting a step signal to a terminator.

This component creates a test setup for validating the Step block by connecting its output to a Terminator. The Step block generates a signal that starts at the offset value and jumps by the height value at the start_time. The test case verifies that the signal properly transitions from the initial offset value to the final value (offset + height).

Usage ​

BlockComponents.StepTest()

Behavior ​

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

Source ​

dyad
"""
Test that validates step response behavior by connecting a step signal to a terminator.

This component creates a test setup for validating the `Step` block by connecting its output
to a `Terminator`. The `Step` block generates a signal that starts at the `offset` value and jumps
by the `height` value at the `start_time`. The test case verifies that the signal properly
transitions from the initial offset value to the final value (offset + height).
"""
test component StepTest
  "Terminates a signal connection without passing it further"
  terminator = Terminator() {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 155, "y1": 20, "x2": 255, "y2": 120, "rot": 0}
      }
    }
  }
  "Generates a step signal with configurable height, offset and start time"
  signal = Step(height = 1.4, offset = 0.5, start_time = 0.5) {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 20, "y1": 20, "x2": 120, "y2": 120, "rot": 0}
      }
    }
  }
relations
  "Connects the step signal 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": 1,
        "expect": {
          "initial": {"signal.y": 0.5},
          "signals": ["signal.y", "terminator.u"],
          "final": {"signal.y": 1.9, "terminator.u": 1.9}
        }
      }
    }
  }
}
end
Flattened Source
dyad
"""
Test that validates step response behavior by connecting a step signal to a terminator.

This component creates a test setup for validating the `Step` block by connecting its output
to a `Terminator`. The `Step` block generates a signal that starts at the `offset` value and jumps
by the `height` value at the `start_time`. The test case verifies that the signal properly
transitions from the initial offset value to the final value (offset + height).
"""
test component StepTest
  "Terminates a signal connection without passing it further"
  terminator = Terminator() {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 155, "y1": 20, "x2": 255, "y2": 120, "rot": 0}
      }
    }
  }
  "Generates a step signal with configurable height, offset and start time"
  signal = Step(height = 1.4, offset = 0.5, start_time = 0.5) {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 20, "y1": 20, "x2": 120, "y2": 120, "rot": 0}
      }
    }
  }
relations
  "Connects the step signal 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": 1,
        "expect": {
          "initial": {"signal.y": 0.5},
          "signals": ["signal.y", "terminator.u"],
          "final": {"signal.y": 1.9, "terminator.u": 1.9}
        }
      }
    }
  }
}
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 = StepTest()
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 = 1e+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, "StepTest_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.5], label="Initial Condition for `signal.y`")
scatter!(plt, [df_case1.t[end]], [1.9], 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.terminator.u])
dfr_case1 = try CSV.read(joinpath(snapshotsdir, "StepTest_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
scatter!(plt, [df_case1.t[end]], [1.9], label="Final Condition for `terminator.u`")
<< @setup-block not executed in draft mode >>
julia
plt
<< @example-block not executed in draft mode >>