Merge pull request #496 from SciML/safer_oop_conversion

safer OOP conversion strategies

Author: ChrisRackauckas

Project.toml

@@ -37,7 +37,7 @@ DiffEqJump = "6.7.5"
 DiffRules = "0.1, 1.0"
 DocStringExtensions = "0.7, 0.8"
 GeneralizedGenerated = "0.1.4, 0.2"
-LabelledArrays = "1.2"
+LabelledArrays = "1.3"
 Latexify = "0.11, 0.12, 0.13"
 LightGraphs = "1.3"
 MacroTools = "0.5"
@@ -55,10 +55,11 @@ julia = "1.2"
 
 [extras]
 Dagger = "d58978e5-989f-55fb-8d15-ea34adc7bf54"
+ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
 OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
 SteadyStateDiffEq = "9672c7b4-1e72-59bd-8a11-6ac3964bc41f"
 StochasticDiffEq = "789caeaf-c7a9-5a7d-9973-96adeb23e2a0"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Dagger", "OrdinaryDiffEq", "SteadyStateDiffEq", "Test", "StochasticDiffEq"]
+test = ["Dagger", "ForwardDiff", "OrdinaryDiffEq", "SteadyStateDiffEq", "Test", "StochasticDiffEq"]

src/build_function.jl

@@ -166,6 +166,7 @@ function _build_function(target::JuliaTarget, rhss, args...;
                          checkbounds = false,
                          linenumbers = false, multithread=nothing,
                          headerfun=addheader, outputidxs=nothing,
+						 convert_oop = true,
                          skipzeros = false, parallel=SerialForm())
 
 	if multithread isa Bool
@@ -336,17 +337,25 @@ function _build_function(target::JuliaTarget, rhss, args...;
 	arr_sys_expr = (typeof(rhss) <: Vector || typeof(rhss) <: Matrix) && !(eltype(rhss) <: AbstractArray) ? quote
 		if typeof($(fargs.args[1])) <: Union{ModelingToolkit.StaticArrays.SArray,ModelingToolkit.LabelledArrays.SLArray}
 			$xname = ModelingToolkit.StaticArrays.@SArray $arr_sys_expr
-			if $(typeof(rhss) <: Vector) # Only try converting if it should match `u`
-				convert(typeof($(fargs.args[1])),$xname)
+			if $convert_oop && !(typeof($(fargs.args[1])) <: Number) && $(typeof(rhss) <: Vector) # Only try converting if it should match `u`
+				return similar_type($(fargs.args[1]),eltype($xname))($xname)
 			else
-				$xname
+				return $xname
 			end
 		else
 			$xname = $arr_sys_expr
-			if !(typeof($(fargs.args[1])) <: Array) && $(typeof(rhss) <: Vector)
-				convert(typeof($(fargs.args[1])),$xname)
+			if $convert_oop && $(typeof(rhss) <: Vector)
+				if !(typeof($(fargs.args[1])) <: Array) && !(typeof($(fargs.args[1])) <: Number) && eltype($(fargs.args[1])) <: eltype($xname)
+					# Last condition: avoid known error because this doesn't change eltypes!
+					return convert(typeof($(fargs.args[1])),$xname)
+				elseif typeof($(fargs.args[1])) <: ModelingToolkit.LabelledArrays.LArray
+					# LArray just needs to add the names back!
+					return ModelingToolkit.LabelledArrays.LArray{ModelingToolkit.LabelledArrays.symnames(typeof($(fargs.args[1])))}($xname)
+				else
+					return $xname
+				end
 			else
-				$xname
+				return $xname
 			end
 		end
 	end : arr_sys_expr

test/labelledarrays.jl

@@ -1,5 +1,5 @@
 using ModelingToolkit, StaticArrays, LinearAlgebra, LabelledArrays
-using DiffEqBase
+using DiffEqBase, ForwardDiff
 using Test
 
 # Define some variables
@@ -9,7 +9,7 @@ using Test
 
 # Define a differential equation
 eqs = [D(x) ~ σ*(y-x),
-       D(y) ~ x*(ρ-z)-y,
+       D(y) ~ t*x*(ρ-z)-y,
        D(z) ~ x*y - β*z]
 
 de = ODESystem(eqs)
@@ -30,3 +30,12 @@ p = SLVector(σ=10.0,ρ=26.0,β=8/3)
 @test ff.jac(c,p,0.0) isa Matrix
 @test ff.jac(a,p,0.0) == ff.jac(b,p,0.0)
 @test ff.jac(a,p,0.0) == ff.jac(c,p,0.0)
+
+# Test similar_type
+@test ff(b,p,ForwardDiff.Dual(0.0,1.0)) isa SLArray
+d = LVector(x=1.0,y=2.0,z=3.0)
+@test ff(d,p,ForwardDiff.Dual(0.0,1.0)) isa LArray
+@test ff.jac(b,p,ForwardDiff.Dual(0.0,1.0)) isa SArray
+@test eltype(ff.jac(b,p,ForwardDiff.Dual(0.0,1.0))) <: ForwardDiff.Dual
+@test ff.jac(d,p,ForwardDiff.Dual(0.0,1.0)) isa Array
+@test eltype(ff.jac(d,p,ForwardDiff.Dual(0.0,1.0))) <: ForwardDiff.Dual