Skip to content
LIBRARY
Math.Tests.Pythagoras.md

Math.Tests.Pythagoras

Test for Pythagoras block in both modes: hypotenuse calculation and leg calculation.

Usage

BlockComponents.Math.Tests.Pythagoras()

Behavior

julia
using BlockComponents #hide
using ModelingToolkit #hide
@named sys = BlockComponents.Math.Tests.Pythagoras() #hide
let eqs = full_equations(sys); Base.length(eqs) > 25 ? nothing : eqs end #hide
<< @example-block not executed in draft mode >>

Source

dyad
"Test for Pythagoras block in both modes: hypotenuse calculation and leg calculation."
test component Pythagoras
  "Leg mode: y = sqrt(u1^2 + u2^2)"
  pyth_leg = BlockComponents.Math.Pythagoras(u1IsHypotenuse = false) {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 180, "y1": 50, "x2": 280, "y2": 150, "rot": 0}
      },
      "tags": []
    }
  }
  "Hypotenuse mode: y = sqrt(u1^2 - u2^2)"
  pyth_hyp = BlockComponents.Math.Pythagoras(u1IsHypotenuse = true) {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 170, "y1": 170, "x2": 270, "y2": 270, "rot": 0}
      },
      "tags": []
    }
  }
  "Input sources"
  u1_src = BlockComponents.Sources.Constant(k = 5.0) {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 20, "y1": 20, "x2": 120, "y2": 120, "rot": 0}
      },
      "tags": []
    }
  }
  u2_src = BlockComponents.Sources.Sine(amplitude = 3.0, frequency = 0.5) {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 20, "y1": 200, "x2": 120, "y2": 300, "rot": 0}
      },
      "tags": []
    }
  }
relations
  connect(u1_src.y, pyth_leg.u1) {"Dyad": {"edges": [{"S": 1, "M": [], "E": 2}], "renderStyle": "standard"}}
  connect(u2_src.y, pyth_leg.u2) {
    "Dyad": {
      "edges": [{"S": 1, "M": [], "E": -1}, {"S": -1, "M": [{"x": 140, "y": 130}], "E": 2}],
      "junctions": [{"x": 140, "y": 250}],
      "renderStyle": "standard"
    }
  }
  connect(u1_src.y, pyth_hyp.u1) {
    "Dyad": {
      "edges": [{"S": 1, "M": [], "E": -1}, {"S": -1, "M": [{"x": 150, "y": 190}], "E": 2}],
      "junctions": [{"x": 150, "y": 70}],
      "renderStyle": "standard"
    }
  }
  connect(u2_src.y, pyth_hyp.u2) {"Dyad": {"edges": [{"S": 1, "M": [], "E": 2}], "renderStyle": "standard"}}
metadata {
  "Dyad": {
    "icons": {"default": "dyad://BlockComponents/Example.svg"},
    "tests": {
      "case1": {
        "stop": 5,
        "expect": {"signals": ["u1_src.y", "u2_src.y", "pyth_leg.y", "pyth_hyp.y"]}
      }
    }
  }
}
end
Flattened Source
dyad
"Test for Pythagoras block in both modes: hypotenuse calculation and leg calculation."
test component Pythagoras
  "Leg mode: y = sqrt(u1^2 + u2^2)"
  pyth_leg = BlockComponents.Math.Pythagoras(u1IsHypotenuse = false) {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 180, "y1": 50, "x2": 280, "y2": 150, "rot": 0}
      },
      "tags": []
    }
  }
  "Hypotenuse mode: y = sqrt(u1^2 - u2^2)"
  pyth_hyp = BlockComponents.Math.Pythagoras(u1IsHypotenuse = true) {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 170, "y1": 170, "x2": 270, "y2": 270, "rot": 0}
      },
      "tags": []
    }
  }
  "Input sources"
  u1_src = BlockComponents.Sources.Constant(k = 5.0) {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 20, "y1": 20, "x2": 120, "y2": 120, "rot": 0}
      },
      "tags": []
    }
  }
  u2_src = BlockComponents.Sources.Sine(amplitude = 3.0, frequency = 0.5) {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "default", "x1": 20, "y1": 200, "x2": 120, "y2": 300, "rot": 0}
      },
      "tags": []
    }
  }
relations
  connect(u1_src.y, pyth_leg.u1) {"Dyad": {"edges": [{"S": 1, "M": [], "E": 2}], "renderStyle": "standard"}}
  connect(u2_src.y, pyth_leg.u2) {
    "Dyad": {
      "edges": [{"S": 1, "M": [], "E": -1}, {"S": -1, "M": [{"x": 140, "y": 130}], "E": 2}],
      "junctions": [{"x": 140, "y": 250}],
      "renderStyle": "standard"
    }
  }
  connect(u1_src.y, pyth_hyp.u1) {
    "Dyad": {
      "edges": [{"S": 1, "M": [], "E": -1}, {"S": -1, "M": [{"x": 150, "y": 190}], "E": 2}],
      "junctions": [{"x": 150, "y": 70}],
      "renderStyle": "standard"
    }
  }
  connect(u2_src.y, pyth_hyp.u2) {"Dyad": {"edges": [{"S": 1, "M": [], "E": 2}], "renderStyle": "standard"}}
metadata {
  "Dyad": {
    "icons": {"default": "dyad://BlockComponents/Example.svg"},
    "tests": {
      "case1": {
        "stop": 5,
        "expect": {"signals": ["u1_src.y", "u2_src.y", "pyth_leg.y", "pyth_hyp.y"]}
      }
    }
  }
}
end


Test Cases

julia
using BlockComponents
using DyadInterface: TransientAnalysis, rebuild_sol, ODEAlg
using ModelingToolkit: toggle_namespacing, get_initial_conditions, @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 = BlockComponents.Math.Tests.Pythagoras()
model_case1 = toggle_namespacing(model_case1, false)

model_case1 = toggle_namespacing(model_case1, true)
result_case1 = TransientAnalysis(; model = model_case1, alg = ODEAlg.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.u1_src.y])
dfr_case1 = try CSV.read(joinpath(snapshotsdir, "BlockComponents.Math.Tests.Pythagoras_case1_sig0.ref"), DataFrame); catch e; nothing; end
plt = plot(sol_case1, idxs=[model_case1.u1_src.y], width=2, label="Actual value of u1_src.y")
if !isnothing(dfr_case1)
  scatter!(plt, dfr_case1.t, dfr_case1.expected, mc=:red, ms=3, label="Expected value of u1_src.y")
end
<< @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.u2_src.y])
dfr_case1 = try CSV.read(joinpath(snapshotsdir, "BlockComponents.Math.Tests.Pythagoras_case1_sig1.ref"), DataFrame); catch e; nothing; end
plt = plot(sol_case1, idxs=[model_case1.u2_src.y], width=2, label="Actual value of u2_src.y")
if !isnothing(dfr_case1)
  scatter!(plt, dfr_case1.t, dfr_case1.expected, mc=:red, ms=3, label="Expected value of u2_src.y")
end
<< @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.pyth_leg.y])
dfr_case1 = try CSV.read(joinpath(snapshotsdir, "BlockComponents.Math.Tests.Pythagoras_case1_sig2.ref"), DataFrame); catch e; nothing; end
plt = plot(sol_case1, idxs=[model_case1.pyth_leg.y], width=2, label="Actual value of pyth_leg.y")
if !isnothing(dfr_case1)
  scatter!(plt, dfr_case1.t, dfr_case1.expected, mc=:red, ms=3, label="Expected value of pyth_leg.y")
end
<< @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.pyth_hyp.y])
dfr_case1 = try CSV.read(joinpath(snapshotsdir, "BlockComponents.Math.Tests.Pythagoras_case1_sig3.ref"), DataFrame); catch e; nothing; end
plt = plot(sol_case1, idxs=[model_case1.pyth_hyp.y], width=2, label="Actual value of pyth_hyp.y")
if !isnothing(dfr_case1)
  scatter!(plt, dfr_case1.t, dfr_case1.expected, mc=:red, ms=3, label="Expected value of pyth_hyp.y")
end
<< @setup-block not executed in draft mode >>
julia
plt
<< @example-block not executed in draft mode >>