Merge pull request #976 from tinosulzer/domain-sets

domain deprecations

Author: ChrisRackauckas

Project.toml

@@ -14,6 +14,7 @@ DiffRules = "b552c78f-8df3-52c6-915a-8e097449b14b"
 Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
+DomainSets = "5b8099bc-c8ec-5219-889f-1d9e522a28bf"
 IfElse = "615f187c-cbe4-4ef1-ba3b-2fcf58d6d173"
 JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
 LabelledArrays = "2ee39098-c373-598a-b85f-a56591580800"
@@ -50,6 +51,7 @@ DiffEqJump = "6.7.5"
 DiffRules = "0.1, 1.0"
 Distributions = "0.23, 0.24, 0.25"
 DocStringExtensions = "0.7, 0.8"
+DomainSets = "0.5"
 IfElse = "0.1"
 JuliaFormatter = "0.12, 0.13"
 LabelledArrays = "1.3"

docs/src/systems/PDESystem.md

@@ -39,17 +39,19 @@ PDESystem
 
 Domains are specifying by saying `indepvar in domain`, where `indepvar` is a
 single or a collection of independent variables, and `domain` is the chosen
-domain type. Thus forms for the `indepvar` can be like:
+domain type. A 2-tuple can be used to indicate an `Interval`. 
+Thus forms for the `indepvar` can be like:
 
 ```julia
-t ∈ IntervalDomain(0.0,1.0)
+t ∈ (0.0,1.0)
 (t,x) ∈ UnitDisk()
 [v,w,x,y,z] ∈ VectorUnitBall(5)
 ```
 
 #### Domain Types (WIP)
 
-- `IntervalDomain(a,b)`: Defines the domain of an interval from `a` to `b`
+- `Interval(a,b)`: Defines the domain of an interval from `a` to `b` (requires explicit
+import from `DomainSets.jl`, but a 2-tuple can be used instead)
 
 ## `discretize` and `symbolic_discretize`
 

src/ModelingToolkit.jl

@@ -158,7 +158,6 @@ export runge_kutta_discretize
 export PDESystem
 export Reaction, ReactionSystem, ismassaction, oderatelaw, jumpratelaw
 export Differential, expand_derivatives, @derivatives
-export IntervalDomain, ProductDomain, ⊗, CircleDomain
 export Equation, ConstrainedEquation
 export Term, Sym
 export SymScope, LocalScope, ParentScope, GlobalScope

src/domains.jl

@@ -1,26 +1,17 @@
-abstract type AbstractDomain{T,N} end
+import DomainSets: Interval, Ball, infimum, supremum
 
-struct VarDomainPairing
-  variables
-  domain::AbstractDomain
-end
-Base.:∈(variable::ModelingToolkit.Num,domain::AbstractDomain) = VarDomainPairing(value(variable),domain)
-Base.:∈(variables::NTuple{N,ModelingToolkit.Num},domain::AbstractDomain) where N = VarDomainPairing(value.(variables),domain)
-
-## Specific Domains
-
-struct IntervalDomain{T} <: AbstractDomain{T,1}
-  lower::T
-  upper::T
-end
-
-
-struct ProductDomain{D,T,N} <: AbstractDomain{T,N}
-  domains::D
-end
-⊗(args::AbstractDomain{T}...) where T = ProductDomain{typeof(args),T,length(args)}(args)
+@deprecate IntervalDomain(a,b) Interval(a,b)
+@deprecate CircleDomain() Ball()
 
-struct CircleDomain <: AbstractDomain{Float64,2}
-  polar::Bool
-  CircleDomain(polar=false) = new(polar)
+# type piracy on Interval for downstream compatibility to be reverted once upgrade is complete
+function Base.getproperty(domain::Interval, sym::Symbol)
+    if sym === :lower
+        @warn "domain.lower is deprecated, use infimum(domain) instead"
+        return infimum(domain)
+    elseif sym === :upper
+        @warn "domain.upper is deprecated, use supremum(domain) instead"
+        return supremum(domain)
+    else
+        return getfield(domain, sym)
+    end
 end

src/systems/pde/pdesystem.jl

@@ -28,8 +28,8 @@ bcs = [u(t,0) ~ 0.,# for all t > 0
        Dt(u(0,x)) ~ 0. ] #for all  0 < x < 1]
 
 # Space and time domains
-domains = [t ∈ IntervalDomain(0.0,1.0),
-           x ∈ IntervalDomain(0.0,1.0)]
+domains = [t ∈ (0.0,1.0),
+           x ∈ (0.0,1.0)]
 
 pde_system = PDESystem(eq,bcs,domains,[t,x],[u])
 ```

test/domains.jl

@@ -9,7 +9,7 @@ eq  = Dt(u(t,x)) ~ Dxx(u(t,x))
 bcs = [u(0,x) ~ - x * (x-1) * sin(x),
            u(t,0) ~ 0, u(t,1) ~ 0]
 
-domains = [t ∈ IntervalDomain(0.0,1.0),
-           x ∈ IntervalDomain(0.0,1.0)]
+domains = [t ∈ (0.0,1.0),
+           x ∈ (0.0,1.0)]
 
 pdesys = PDESystem(eq,bcs,domains,[t,x],[u])

test/pde.jl

@@ -18,7 +18,6 @@ using SafeTestsets, Test
 @safetestset "ReactionSystem Test" begin include("reactionsystem_components.jl") end
 @safetestset "JumpSystem Test" begin include("jumpsystem.jl") end
 @safetestset "ControlSystem Test" begin include("controlsystem.jl") end
-@safetestset "Domain Test" begin include("domains.jl") end
 @safetestset "Modelingtoolkitize Test" begin include("modelingtoolkitize.jl") end
 @safetestset "Constraints Test" begin include("constraints.jl") end
 @safetestset "Reduction Test" begin include("reduction.jl") end