CosineTest

Tests the integration of a cosine signal with configurable parameters.

This component connects a cosine signal generator to an integrator and verifies the correct integration behavior through test cases. The cosine signal is defined by:

$$y=offset+amplitude\cdot \cos (2\pi \cdot frequency\cdot (time-start\mathrm{\_}time)+phase)$$

The integration of this signal is verified against expected values at specific time points.

Usage

CosineTest()

Behavior

using BlockComponents #hide
using ModelingToolkit #hide
@named sys = CosineTest() #hide
full_equations(sys) #hide

<< @example-block not executed in draft mode >>

Source

# Tests the integration of a cosine signal with configurable parameters.
#
# This component connects a cosine signal generator to an integrator and verifies the correct
# integration behavior through test cases. The cosine signal is defined by:
#
# ```math
# y = offset + amplitude \cdot \cos(2\pi \cdot frequency \cdot (time - start\_time) + phase)
# ```
#
# The integration of this signal is verified against expected values at specific time points.
test component CosineTest
  # Integrator component that accumulates the input signal
  integrator = Integrator()
  # Cosine signal generator with specified amplitude, frequency, start time, offset, and phase
  signal = Cosine(amplitude=1, frequency=2, start_time=0.5, offset=0.5, phase=3.14)
relations
  # Connects the output of the cosine signal to the input of the integrator
  connect(signal.y, integrator.u)
metadata {
  "Dyad": {
    "tests": {
      "case1": {
        "stop": 5,
        "atol": {"signal.y": 0.001, "integrator.x": 0.001},
        "expect": {
          "initial": {"signal.y": 0.5},
          "signals": ["signal.y", "integrator.x"],
          "final": {"signal.y": -0.5, "integrator.x": 2.5}
        }
      }
    }
  }
}
end

Flattened Source

# Tests the integration of a cosine signal with configurable parameters.
#
# This component connects a cosine signal generator to an integrator and verifies the correct
# integration behavior through test cases. The cosine signal is defined by:
#
# ```math
# y = offset + amplitude \cdot \cos(2\pi \cdot frequency \cdot (time - start\_time) + phase)
# ```
#
# The integration of this signal is verified against expected values at specific time points.
test component CosineTest
  # Integrator component that accumulates the input signal
  integrator = Integrator()
  # Cosine signal generator with specified amplitude, frequency, start time, offset, and phase
  signal = Cosine(amplitude=1, frequency=2, start_time=0.5, offset=0.5, phase=3.14)
relations
  # Connects the output of the cosine signal to the input of the integrator
  connect(signal.y, integrator.u)
metadata {
  "Dyad": {
    "tests": {
      "case1": {
        "stop": 5,
        "atol": {"signal.y": 0.001, "integrator.x": 0.001},
        "expect": {
          "initial": {"signal.y": 0.5},
          "signals": ["signal.y", "integrator.x"],
          "final": {"signal.y": -0.5, "integrator.x": 2.5}
        }
      }
    }
  }
}
end

Test Cases

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

@mtkbuild model_case1 = CosineTest()
u0_case1 = []
prob_case1 = ODEProblem(model_case1, u0_case1, (0, 5))
sol_case1 = solve(prob_case1)

<< @setup-block not executed in draft mode >>

df_case1 = DataFrame(:t => sol_case1[:t], :actual => sol_case1[model_case1.signal.y])
dfr_case1 = try CSV.read(joinpath(snapshotsdir, "CosineTest_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]], [-0.5], label="Final Condition for `signal.y`")

<< @setup-block not executed in draft mode >>

plt

<< @example-block not executed in draft mode >>

df_case1 = DataFrame(:t => sol_case1[:t], :actual => sol_case1[model_case1.integrator.x])
dfr_case1 = try CSV.read(joinpath(snapshotsdir, "CosineTest_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.5], label="Final Condition for `integrator.x`")

<< @setup-block not executed in draft mode >>

plt

<< @example-block not executed in draft mode >>

Related

• Examples

• Experiments

• Analyses

• Tests

  • Cosine

  • Integrator