Skip to content

Problem construction throws invalid unit validation error in InitializationProblem construction stage for some systems #3969

@bspanoghe

Description

@bspanoghe

Describe the bug 🐞

Some systems throw an invalid unit validation error during problem construction (specifically in the initialization problem construction stage), seemingly caused by automatically generated intermediate variables. The sphere-shaped system described in the MRE throws an error, while the equivalent cuboid-shaped system described in additional context runs perfectly.

Expected behavior

The problem should be constructed without unit validation error.

Minimal Reproducible Example 👇

I encounter the problem in a large system of connected hydraulic components that can change dimensions under influence of pressure. Below is a heavily simplified version of a single, spherical component.

using ModelingToolkit, DynamicQuantities

@independent_variables t, [description = "Time", unit = u"s"];
d = Differential(t);

function Hydraulics(; name, P, D)
    @parameters begin
        ϵ_D = 1.0, [description = "Elasticity", unit = u"Pa"]
        K = 1.0, [description = "Hydraulic conductivity", unit = u"m^3 / s / Pa"]
    end

    @variables begin
        P(t) = P, [description = "Water pressure", unit = u"Pa"]
        D(t) = D, [description = "Dimension (radius)", unit = u"m"]
        V(t), [description = "Volume", unit = u"m^3"]
    end

    eqs = [
        V ~ 4/3 * pi * D^3, # (m^3) = (m)^3
        d(V) ~ -K*P, # (m^3 / s) = (m^3 / s / Pa) * Pa
        d(D) ~ 1/ϵ_D * D*d(P), # (m / s) = (1 / Pa) * (m) * (Pa / s)
    ]
    return System(eqs, t; name)
end

@mtkcompile system = Hydraulics(P = 1.0, D = 1.0);
prob = ODEProblem(system, [], (0.0, 10.0));

Error & Stacktrace ⚠️

┌ Warning:  in eq. #1right, in sum var"####subexpr#233#234" + (var"####subexpr#231#232"*Pˍt(t)) / ϵ_D, units [1.0 s⁻¹, 1.0 ] do not match.
└ @ ModelingToolkit C:\Users\bspanogh\.julia\packages\ModelingToolkit\80wTI\src\systems\unit_check.jl:181
ERROR: ModelingToolkit.ValidationError("Some equations had invalid units. See warnings for details.")
Click for stacktrace
Stacktrace:
  [1] check_units
    @ C:\Users\bspanogh\.julia\packages\ModelingToolkit\80wTI\src\systems\unit_check.jl:318 [inlined]
  [2] System(tag::UInt64, eqs::Vector{…}, noise_eqs::Nothing, jumps::Vector{…}, constraints::Vector{…}, costs::Vector{…}, consolidate::typeof(ModelingToolkit.default_consolidate), unknowns::Vector{…}, ps::Vector{…}, brownians::Vector{…}, iv::Nothing, observed::Vector{…}, parameter_dependencies::Vector{…}, var_to_name::Dict{…}, name::Symbol, description::String, defaults::Dict{…}, guesses::Dict{…}, systems::Vector{…}, initialization_eqs::Vector{…}, continuous_events::Vector{…}, discrete_events::Vector{…}, connector_type::Nothing, assertions::Dict{…}, metadata::Base.ImmutableDict{…}, gui_metadata::Nothing, is_dde::Bool, tstops::Vector{…}, inputs::OrderedCollections.OrderedSet{…}, outputs::OrderedCollections.OrderedSet{…}, tearing_state::Nothing, namespacing::Bool, complete::Bool, index_cache::Nothing, ignored_connections::Nothing, preface::Vector{…}, parent::Nothing, initializesystem::Nothing, is_initializesystem::Bool, is_discrete::Bool, isscheduled::Bool, schedule::Nothing; checks::Bool)
    @ ModelingToolkit C:\Users\bspanogh\.julia\packages\ModelingToolkit\80wTI\src\systems\system.jl:296
  [3] System
    @ C:\Users\bspanogh\.julia\packages\ModelingToolkit\80wTI\src\systems\system.jl:263 [inlined]
  [4] System(eqs::Vector{…}, iv::Nothing, dvs::Vector{…}, ps::Vector{…}, brownians::Vector{…}; constraints::Vector{…}, noise_eqs::Nothing, jumps::Vector{…}, costs::Vector{…}, consolidate::Function, observed::Vector{…}, parameter_dependencies::Vector{…}, defaults::Dict{…}, guesses::Dict{…}, systems::Vector{…}, initialization_eqs::Vector{…}, continuous_events::Vector{…}, discrete_events::Vector{…}, connector_type::Nothing, assertions::Dict{…}, metadata::Base.ImmutableDict{…}, gui_metadata::Nothing, is_dde::Nothing, tstops::Vector{…}, inputs::OrderedCollections.OrderedSet{…}, outputs::OrderedCollections.OrderedSet{…}, tearing_state::Nothing, ignored_connections::Nothing, parent::Nothing, description::String, name::Symbol, discover_from_metadata::Bool, initializesystem::Nothing, is_initializesystem::Bool, is_discrete::Bool, preface::Vector{…}, checks::Bool)
    @ ModelingToolkit C:\Users\bspanogh\.julia\packages\ModelingToolkit\80wTI\src\systems\system.jl:452
  [5] System
    @ C:\Users\bspanogh\.julia\packages\ModelingToolkit\80wTI\src\systems\system.jl:339 [inlined]
  [6] #System#720
    @ C:\Users\bspanogh\.julia\packages\ModelingToolkit\80wTI\src\systems\system.jl:468 [inlined]
  [7] ModelingToolkit.SCCNonlinearFunction{…}(sys::System, _eqs::Vector{…}, _dvs::Vector{…}, _obs::Vector{…}, cachesyms::Tuple{…}, op::Dict{…}; eval_expression::Bool, eval_module::Module, cse::Bool, kwargs::@Kwargs{})
    @ ModelingToolkit C:\Users\bspanogh\.julia\packages\ModelingToolkit\80wTI\src\problems\sccnonlinearproblem.jl:45
  [8] (SCCNonlinearProblem{} where iip)(sys::System, op::Dict{…}; eval_expression::Bool, eval_module::Module, cse::Bool, u0_constructor::Function,
 kwargs::@Kwargs{})
    @ ModelingToolkit C:\Users\bspanogh\.julia\packages\ModelingToolkit\80wTI\src\problems\sccnonlinearproblem.jl:231
  [9] InitializationProblem{…}(sys::System, t::Float64, op::Dict{…}; guesses::Dict{…}, check_length::Bool, warn_initialize_determined::Bool, initialization_eqs::Vector{…}, fully_determined::Nothing, check_units::Bool, use_scc::Bool, allow_incomplete::Bool, algebraic_only::Bool, time_dependent_init::Bool, kwargs::@Kwargs{})
    @ ModelingToolkit C:\Users\bspanogh\.julia\packages\ModelingToolkit\80wTI\src\problems\initializationproblem.jl:138
 [10] InitializationProblem
    @ C:\Users\bspanogh\.julia\packages\ModelingToolkit\80wTI\src\problems\initializationproblem.jl:20 [inlined]
 [11] #_#1109
    @ .\none:0 [inlined]
 [12] maybe_build_initialization_problem(sys::System, iip::Bool, op::Dict{…}, t::Float64, defs::Dict{…}, guesses::Dict{…}, missing_unknowns::Set{…}; implicit_dae::Bool, time_dependent_init::Bool, u0_constructor::Function, p_constructor::Function, floatT::Type, initialization_eqs::Vector{…}, use_scc::Bool, eval_expression::Bool, eval_module::Module, kwargs::@Kwargs{})
    @ ModelingToolkit C:\Users\bspanogh\.julia\packages\ModelingToolkit\80wTI\src\systems\problem_utils.jl:1128
 [13] process_SciMLProblem(constructor::Type, sys::System, op::Vector{…}; build_initializeprob::Bool, implicit_dae::Bool, t::Float64, guesses::Dict{…}, warn_initialize_determined::Bool, initialization_eqs::Vector{…}, eval_expression::Bool, eval_module::Module, fully_determined::Nothing, check_initialization_units::Bool, u0_eltype::Nothing, tofloat::Bool, u0_constructor::typeof(identity), p_constructor::typeof(identity), check_length::Bool, symbolic_u0::Bool, warn_cyclic_dependency::Bool, circular_dependency_max_cycle_length::Int64, circular_dependency_max_cycles::Int64, substitution_limit::Int64, use_scc::Bool, time_dependent_init::Bool, algebraic_only::Bool, allow_incomplete::Bool, is_initializeprob::Bool, kwargs::@Kwargs{})
    @ ModelingToolkit C:\Users\bspanogh\.julia\packages\ModelingToolkit\80wTI\src\systems\problem_utils.jl:1400
 [14] (ODEProblem{})(sys::System, op::Vector{…}, tspan::Tuple{…}; callback::Nothing, check_length::Bool, eval_expression::Bool, expression::Type, eval_module::Module, check_compatibility::Bool, kwargs::@Kwargs{})
    @ ModelingToolkit C:\Users\bspanogh\.julia\packages\ModelingToolkit\80wTI\src\problems\odeproblem.jl:81
 [15] ODEProblem
    @ C:\Users\bspanogh\.julia\packages\ModelingToolkit\80wTI\src\problems\odeproblem.jl:73 [inlined]
 [16] ODEProblem
    @ .\none:0 [inlined]
 [17] ODEProblem(sys::System, op::Vector{Any}, tspan::Tuple{Float64, Float64})
    @ ModelingToolkit .\none:0
 [18] top-level scope
ivative.jl:1

Environment (please complete the following information):

  • Output of using Pkg; Pkg.status()
Status `~\Project.toml`
  [06fc5a27] DynamicQuantities v1.10.0
  [961ee093] ModelingToolkit v10.26.0
  • Output of using Pkg; Pkg.status(; mode = PKGMODE_MANIFEST)
Click for manifest
Status `~\Manifest.toml`
  [47edcb42] ADTypes v1.18.0
  [1520ce14] AbstractTrees v0.4.5
  [7d9f7c33] Accessors v0.1.42
  [79e6a3ab] Adapt v4.4.0
  [66dad0bd] AliasTables v1.1.3
  [ec485272] ArnoldiMethod v0.4.0
  [4fba245c] ArrayInterface v7.20.0
  [4c555306] ArrayLayouts v1.12.0
  [e2ed5e7c] Bijections v0.2.2
  [62783981] BitTwiddlingConvenienceFunctions v0.1.6
  [8e7c35d0] BlockArrays v1.7.2
  [70df07ce] BracketingNonlinearSolve v1.5.0
  [2a0fbf3d] CPUSummary v0.2.7
  [d360d2e6] ChainRulesCore v1.26.0
  [fb6a15b2] CloseOpenIntervals v0.1.13
⌅ [861a8166] Combinatorics v1.0.2
  [a80b9123] CommonMark v0.9.1
  [38540f10] CommonSolve v0.2.4
  [bbf7d656] CommonSubexpressions v0.3.1
  [f70d9fcc] CommonWorldInvalidations v1.0.0
  [34da2185] Compat v4.18.1
  [b152e2b5] CompositeTypes v0.1.4
  [a33af91c] CompositionsBase v0.1.2
  [2569d6c7] ConcreteStructs v0.2.3
  [187b0558] ConstructionBase v1.6.0
  [adafc99b] CpuId v0.3.1
  [9a962f9c] DataAPI v1.16.0
  [864edb3b] DataStructures v0.19.1
  [2b5f629d] DiffEqBase v6.190.2
  [459566f4] DiffEqCallbacks v4.10.1
  [77a26b50] DiffEqNoiseProcess v5.24.1
  [163ba53b] DiffResults v1.1.0
  [b552c78f] DiffRules v1.15.1
  [a0c0ee7d] DifferentiationInterface v0.7.9
  [8d63f2c5] DispatchDoctor v0.4.26
  [31c24e10] Distributions v0.25.122
  [ffbed154] DocStringExtensions v0.9.5
  [5b8099bc] DomainSets v0.7.16
  [7c1d4256] DynamicPolynomials v0.6.4
  [06fc5a27] DynamicQuantities v1.10.0
  [4e289a0a] EnumX v1.0.5
  [f151be2c] EnzymeCore v0.8.14
  [e2ba6199] ExprTools v0.1.10
  [55351af7] ExproniconLite v0.10.14
  [7034ab61] FastBroadcast v0.3.5
  [9aa1b823] FastClosures v0.3.2
  [a4df4552] FastPower v1.1.3
  [1a297f60] FillArrays v1.14.0
  [64ca27bc] FindFirstFunctions v1.4.2
  [6a86dc24] FiniteDiff v2.29.0
  [1fa38f19] Format v1.3.7
  [f6369f11] ForwardDiff v1.2.1
  [069b7b12] FunctionWrappers v1.1.3
  [77dc65aa] FunctionWrappersWrappers v0.1.3
  [46192b85] GPUArraysCore v0.2.0
  [c27321d9] Glob v1.3.1
  [86223c79] Graphs v1.13.1
  [34004b35] HypergeometricFunctions v0.3.28
  [615f187c] IfElse v0.1.1
  [3263718b] ImplicitDiscreteSolve v1.2.0
  [d25df0c9] Inflate v0.1.5
  [18e54dd8] IntegerMathUtils v0.1.3
  [8197267c] IntervalSets v0.7.11
  [3587e190] InverseFunctions v0.1.17
  [92d709cd] IrrationalConstants v0.2.6
  [82899510] IteratorInterfaceExtensions v1.0.0
  [692b3bcd] JLLWrappers v1.7.1
  [ae98c720] Jieko v0.2.1
  [98e50ef6] JuliaFormatter v2.1.6
⌅ [70703baa] JuliaSyntax v0.4.10
  [ccbc3e58] JumpProcesses v9.19.1
  [b964fa9f] LaTeXStrings v1.4.0
  [23fbe1c1] Latexify v0.16.10
  [10f19ff3] LayoutPointers v0.1.17
  [87fe0de2] LineSearch v0.1.4
  [d3d80556] LineSearches v7.4.0
  [2ab3a3ac] LogExpFunctions v0.3.29
  [d8e11817] MLStyle v0.4.17
  [1914dd2f] MacroTools v0.5.16
  [d125e4d3] ManualMemory v0.1.8
  [bb5d69b7] MaybeInplace v0.1.4
  [e1d29d7a] Missings v1.2.0
  [961ee093] ModelingToolkit v10.26.0
  [2e0e35c7] Moshi v0.3.7
  [46d2c3a1] MuladdMacro v0.2.4
  [102ac46a] MultivariatePolynomials v0.5.13
  [d8a4904e] MutableArithmetics v1.6.6
  [d41bc354] NLSolversBase v7.10.0
  [77ba4419] NaNMath v1.1.3
  [be0214bd] NonlinearSolveBase v2.0.0
  [6fe1bfb0] OffsetArrays v1.17.0
  [429524aa] Optim v1.13.2
  [bac558e1] OrderedCollections v1.8.1
  [bbf590c4] OrdinaryDiffEqCore v1.36.0
  [90014a1f] PDMats v0.11.35
  [d96e819e] Parameters v0.12.3
  [e409e4f3] PoissonRandom v0.4.7
  [f517fe37] Polyester v0.7.18
  [1d0040c9] PolyesterWeave v0.2.2
  [85a6dd25] PositiveFactorizations v0.2.4
  [d236fae5] PreallocationTools v0.4.34
⌅ [aea7be01] PrecompileTools v1.2.1
  [21216c6a] Preferences v1.5.0
  [27ebfcd6] Primes v0.5.7
  [43287f4e] PtrArrays v1.3.0
  [1fd47b50] QuadGK v2.11.2
  [74087812] Random123 v1.7.1
  [e6cf234a] RandomNumbers v1.6.0
  [3cdcf5f2] RecipesBase v1.3.4
  [731186ca] RecursiveArrayTools v3.37.1
  [189a3867] Reexport v1.2.2
  [ae029012] Requires v1.3.1
  [ae5879a3] ResettableStacks v1.1.1
  [79098fc4] Rmath v0.8.0
  [7e49a35a] RuntimeGeneratedFunctions v0.5.15
  [9dfe8606] SCCNonlinearSolve v1.6.0
  [94e857df] SIMDTypes v0.1.0
  [0bca4576] SciMLBase v2.121.1
  [19f34311] SciMLJacobianOperators v0.1.11
  [c0aeaf25] SciMLOperators v1.9.0
  [431bcebd] SciMLPublic v1.0.0
  [53ae85a6] SciMLStructures v1.7.0
  [efcf1570] Setfield v1.1.2
  [727e6d20] SimpleNonlinearSolve v2.9.0
  [699a6c99] SimpleTraits v0.9.5
  [ce78b400] SimpleUnPack v1.1.0
  [a2af1166] SortingAlgorithms v1.2.2
  [276daf66] SpecialFunctions v2.6.1
  [aedffcd0] Static v1.3.0
  [0d7ed370] StaticArrayInterface v1.8.0
  [90137ffa] StaticArrays v1.9.15
  [1e83bf80] StaticArraysCore v1.4.3
  [10745b16] Statistics v1.11.1
  [82ae8749] StatsAPI v1.7.1
  [2913bbd2] StatsBase v0.34.6
  [4c63d2b9] StatsFuns v1.5.0
  [7792a7ef] StrideArraysCore v0.5.8
  [2efcf032] SymbolicIndexingInterface v0.3.46
⌃ [19f23fe9] SymbolicLimits v0.2.3
⌅ [d1185830] SymbolicUtils v3.32.0
  [0c5d862f] Symbolics v6.56.0
  [ed4db957] TaskLocalValues v0.1.3
  [8ea1fca8] TermInterface v2.0.0
  [1c621080] TestItems v1.0.0
  [8290d209] ThreadingUtilities v0.5.5
  [a759f4b9] TimerOutputs v0.5.29
  [410a4b4d] Tricks v0.1.12
  [781d530d] TruncatedStacktraces v1.4.0
  [5c2747f8] URIs v1.6.1
  [3a884ed6] UnPack v1.0.2
  [1986cc42] Unitful v1.25.0
  [a7c27f48] Unityper v0.1.6
  [61579ee1] Ghostscript_jll v9.55.1+0
  [aacddb02] JpegTurbo_jll v3.1.3+0
  [efe28fd5] OpenSpecFun_jll v0.5.6+0
  [f50d1b31] Rmath_jll v0.5.1+0
  [56f22d72] Artifacts v1.11.0
  [2a0f44e3] Base64 v1.11.0
  [ade2ca70] Dates v1.11.0
  [8ba89e20] Distributed v1.11.0
  [9fa8497b] Future v1.11.0
  [b77e0a4c] InteractiveUtils v1.11.0
  [8f399da3] Libdl v1.11.0
  [37e2e46d] LinearAlgebra v1.11.0
  [56ddb016] Logging v1.11.0
  [d6f4376e] Markdown v1.11.0
  [a63ad114] Mmap v1.11.0
  [de0858da] Printf v1.11.0
  [9a3f8284] Random v1.11.0
  [ea8e919c] SHA v0.7.0
  [9e88b42a] Serialization v1.11.0
  [1a1011a3] SharedArrays v1.11.0
  [6462fe0b] Sockets v1.11.0
  [2f01184e] SparseArrays v1.11.0
  [4607b0f0] SuiteSparse
  [fa267f1f] TOML v1.0.3
  [8dfed614] Test v1.11.0
  [cf7118a7] UUIDs v1.11.0
  [4ec0a83e] Unicode v1.11.0
  [e66e0078] CompilerSupportLibraries_jll v1.1.1+0
  [4536629a] OpenBLAS_jll v0.3.27+1
  [05823500] OpenLibm_jll v0.8.5+0
  [bea87d4a] SuiteSparse_jll v7.7.0+0
  [83775a58] Zlib_jll v1.2.13+1
  [8e850b90] libblastrampoline_jll v5.11.0+0
Info Packages marked with ⌃ and ⌅ have new versions available. Those with ⌃ may be upgradable, but those with ⌅ are restricted by compatibility constraints from upgrading. To see why use `status --outdated -m`
  • Output of versioninfo()
Julia Version 1.11.6
Commit 9615af0f26 (2025-07-09 12:58 UTC)
Build Info:
  Official https://julialang.org/ release
Platform Info:
  OS: Windows (x86_64-w64-mingw32)
  CPU: 12 × 12th Gen Intel(R) Core(TM) i7-1265U
  WORD_SIZE: 64
  LLVM: libLLVM-16.0.6 (ORCJIT, alderlake)
Threads: 1 default, 0 interactive, 1 GC (on 12 virtual cores)
Environment:
  JULIA_EDITOR = code
  JULIA_VSCODE_REPL = 1
  JULIA_NUM_THREADS = 1

Additional context

  • The system runs perfectly when defined without units.

  • These are the equations generated by the initializationsystem:

julia> generate_initializesystem(system) |> equations
5-element Vector{Equation}:
 0 ~ -V(t) + 4.1887902047863905(D(t)^3)
 0 ~ K*P(t) + 12.566370614359172(D(t)^2)*Dˍt(t)
 0 ~ (Pˍt(t)*D(t)) / ϵ_D - Dˍt(t)
 D(t) ~ Initial(D(t))
 P(t) ~ Initial(P(t))

Based on the error message Warning: in eq. #1right, in sum var"####subexpr#233#234" + (var"####subexpr#231#232"*Pˍt(t)) / ϵ_D, units [1.0 s⁻¹, 1.0 ] do not match., it seems that something goes wrong in the third equation.

  • The same system defined for a cuboid shape runs without error:
using ModelingToolkit, DynamicQuantities

@independent_variables t, [description = "Time", unit = u"s"];
d = Differential(t);

function Hydraulics(; name, P, D)
    @parameters begin
        ϵ_D[1:3] = [1.0, 2.0, 3.0], [description = "Elasticity", unit = u"Pa"]
        K = 1.0, [description = "Hydraulic conductivity", unit = u"m^3 / s / Pa"]
    end

    @variables begin
        P(t) = P, [description = "Water pressure", unit = u"Pa"]
        D(t)[1:3] = D, [description = "Dimensions (length, width, height)", unit = u"m"]
        V(t), [description = "Volume", unit = u"m^3"]
    end

    eqs = [
        V ~ D[1]*D[2]*D[3],
        d(V) ~ -K*P,
        d(D[1]) ~ 1/ϵ_D[1] * D[1]*d(P),
        d(D[2]) ~ 1/ϵ_D[2] * D[2]*d(P),
        d(D[3]) ~ 1/ϵ_D[3] * D[3]*d(P),
    ]
    return System(eqs, t; name)
end

@mtkcompile system = Hydraulics(P = 1.0, D = [1.0, 1.0, 1.0]);
prob = ODEProblem(system, [], (0.0, 10.0));
  • For some extra context: the compartments can have any shape, so D(t) is generally a 1 to 3 dimensional vector with a function to calculate its volume based on the shape. Every dimension of the compartment can extend or contract with a different elasticity, so the equation defining change in size based on pressure is defined for every dimension separately.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions