HarmonicEquation tests

Author: oameye

src/HarmonicEquation.jl

@@ -175,7 +175,13 @@ function is_rearranged(eom::HarmonicEquation)
     return HB_bool || hopf_bool || MF_bool
 end
 
+"""
+$(TYPEDSIGNATURES)
+
+(Re)-declare the variables of `eom` in module scope.
+"""
 function declare_variables(eom::HarmonicEquation)
     vars_orig = get_variables(eom)
     return declare_variable.(var_name.(vars_orig))
 end
+# TODO should this be the variable with independent_variable or without independent_variable?

src/HarmonicVariable.jl

@@ -113,7 +113,7 @@ function d(f::Num, x::Num, deg=1)::Num
 end
 d(funcs::Vector{Num}, x::Num, deg=1) = Num[d(f, x, deg) for f in funcs]
 
-"Declare a variable in the the currently active namespace"
+"Declare a variable in the the currently active Module namespace"
 function declare_variable(name::String)
     var_sym = Symbol(name)
     @eval($(var_sym) = first(Symbolics.@variables $var_sym))
@@ -122,7 +122,7 @@ end
 
 declare_variable(x::Num) = declare_variable(string(x))
 
-"Declare a variable that is a function of another variable in the the current namespace"
+"Declare a variable that is a function of another variable in the Module namespace"
 function declare_variable(name::String, independent_variable::Num)
     # independent_variable = declare_variable(independent_variable) convert string into Num
     var_sym = Symbol(name)

test/HarmonicEquation.jl

@@ -0,0 +1,95 @@
+# test/test_HarmonicEquation.jl
+using Test
+using Symbolics
+using SymbolicUtils
+using QuestBase
+using QuestBase:
+    DifferentialEquation,
+    HarmonicVariable,
+    HarmonicEquation,
+    _parameters,
+    get_variables,
+    get_independent_variables,
+    rearrange_standard,
+    substitute_all,
+    is_rearranged,
+    _remove_brackets,
+    declare_variables,
+    dummy_symbolic_Jacobian,
+    @eqtest,
+    get_all_terms,
+    get_independent
+
+# Setup common test variables
+@variables t, T
+@variables x(t) y(t) u(T) v(T)
+D = Differential(T)
+
+# Create simple test equation
+eq1 = D(u) ~ u + v
+eq2 = D(v) ~ -u + v
+nat_eq = DifferentialEquation([eq1, eq2], [x, y])
+
+# Create test harmonic variables
+hv1 = HarmonicVariable(u, "test", "u", Num(1.0), x)
+hv2 = HarmonicVariable(v, "test", "v", Num(1.0), y)
+
+# Test constructor
+@testset "Construction" begin
+    heq1 = HarmonicEquation([eq1, eq2], [hv1, hv2], nat_eq)
+    heq2 = HarmonicEquation([eq1, eq2], [hv1, hv2], Num[], nat_eq)
+    for heq in [heq1, heq2]
+        heq = heq1
+        @test heq.equations == [eq1, eq2]
+        @test heq.variables == [hv1, hv2]
+        @test heq.natural_equation == nat_eq
+        @test heq.parameters == Num[]
+        @test heq.jacobian isa Matrix{Num}
+    end
+end
+
+@testset "Parameter handling" begin
+    parvar = @variables p q
+    eq_with_params = D(u) ~ p * v + q * v
+    heq = HarmonicEquation([eq_with_params, eq2], [hv1, hv2], nat_eq)
+    params = _parameters(heq)
+    @eqtest params == parvar
+end
+
+@testset "Variable handling" begin
+    heq = HarmonicEquation([eq1, eq2], [hv1, hv2], nat_eq)
+    vars = get_variables(heq)
+    @test length(vars) == 2
+    @eqtest [T] == get_independent_variables(heq)
+end
+
+@testset "Equation manipulation" begin
+    heq = HarmonicEquation([eq1, eq2], [hv1, hv2], nat_eq)
+
+    # Test rearrange
+    rearranged = rearrange_standard(heq)
+    @test is_rearranged(rearranged)
+
+    # Test substitute_all
+    @variables a
+    rules = Dict(u => a)
+    subbed = substitute_all(heq, rules)
+    @test !isequal(subbed.equations, heq.equations)
+end
+
+@testset "Utility functions" begin
+    heq = HarmonicEquation([eq1, eq2], [hv1, hv2], nat_eq)
+
+    # Test _remove_brackets
+    no_brackets = _remove_brackets(heq)
+
+    list = get_all_terms.(Symbolics.expand_derivatives.(no_brackets))
+    list = unique(filter(x -> !(x isa Real), Symbolics.unwrap.(reduce(vcat, list))))
+    @test all(map(x -> !hasproperty(x, :arguments), list))
+
+    # Test declare_variables
+    declared = declare_variables(heq)
+    list = get_all_terms.(Symbolics.expand_derivatives.(declared))
+    list = unique(filter(x -> !(x isa Real), Symbolics.unwrap.(reduce(vcat, list))))
+    @test all(map(x -> !hasproperty(x, :arguments), list))
+end

test/runtests.jl

@@ -12,3 +12,7 @@ end
 @testset "Symbolics customised" begin
     include("symbolics.jl")
 end
+
+@testset "HarmonicEquation" begin
+    include("HarmonicEquation.jl")
+end