Dyad

Appearance

SquareTest.md

SquareTest ​

Connects a square wave generator to an integrator to test integration of a periodic signal.

This component demonstrates the integration of a square wave over time. It connects a Square signal generator (with amplitude 1, frequency 2 Hz, start time 0.5 seconds, and offset 0.7) to an Integrator block. The square wave alternates between values of 0.7 and 1.7, and when integrated, should reach approximately 3.537 at t=5 seconds.

Usage ​

SquareTest()

Behavior ​

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

Source ​

dyad
# Connects a square wave generator to an integrator to test integration of a periodic signal.
#
# This component demonstrates the integration of a square wave over time. It connects a Square
# signal generator (with amplitude 1, frequency 2 Hz, start time 0.5 seconds, and offset 0.7)
# to an Integrator block. The square wave alternates between values of 0.7 and 1.7, and when
# integrated, should reach approximately 3.537 at t=5 seconds.
test component SquareTest
  # Integrator block that accumulates the square wave input
  integrator = Integrator()
  # Square wave generator with specified amplitude, frequency, start time and offset
  signal = Square(amplitude=1, frequency=2, start_time=0.5, offset=0.7)
relations
  connect(signal.y, integrator.u)
metadata {
  "Dyad": {
    "tests": {
      "case1": {
        "stop": 5,
        "atol": {"integrator.x": 0.001},
        "expect": {
          "initial": {"signal.y": 0.7},
          "signals": ["signal.y", "integrator.x"],
          "final": {"signal.y": 1.7, "integrator.x": 3.5}
        }
      }
    }
  }
}
end
Flattened Source
dyad
# Connects a square wave generator to an integrator to test integration of a periodic signal.
#
# This component demonstrates the integration of a square wave over time. It connects a Square
# signal generator (with amplitude 1, frequency 2 Hz, start time 0.5 seconds, and offset 0.7)
# to an Integrator block. The square wave alternates between values of 0.7 and 1.7, and when
# integrated, should reach approximately 3.537 at t=5 seconds.
test component SquareTest
  # Integrator block that accumulates the square wave input
  integrator = Integrator()
  # Square wave generator with specified amplitude, frequency, start time and offset
  signal = Square(amplitude=1, frequency=2, start_time=0.5, offset=0.7)
relations
  connect(signal.y, integrator.u)
metadata {
  "Dyad": {
    "tests": {
      "case1": {
        "stop": 5,
        "atol": {"integrator.x": 0.001},
        "expect": {
          "initial": {"signal.y": 0.7},
          "signals": ["signal.y", "integrator.x"],
          "final": {"signal.y": 1.7, "integrator.x": 3.5}
        }
      }
    }
  }
}
end


Test Cases ​

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

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

Test Case case1 ​

julia
@mtkbuild model_case1 = SquareTest()
u0_case1 = []
prob_case1 = ODEProblem(model_case1, u0_case1, (0, 5))
sol_case1 = solve(prob_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, "SquareTest_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.7], label="Initial Condition for `signal.y`")
scatter!(plt, [df_case1.t[end]], [1.7], 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, "SquareTest_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]], [3.5], label="Final Condition for `integrator.x`")
<< @setup-block not executed in draft mode >>
julia
plt
<< @example-block not executed in draft mode >>