offside changed to kwargs

Author: mjsheikh

src/derivative_operators/derivative_operator.jl

@@ -187,7 +187,7 @@ julia> Array(L2 * Q)[1]
 """
 function UpwindDifference{N}(derivative_order::Int,
                              approximation_order::Int, dx::T,
-                             len::Int, offside::Int, coeff_func=nothing) where {T<:Real,N}
+                             len::Int, coeff_func=nothing; offside::Int=0) where {T<:Real,N}
 
     @assert offside > -1 "Number of offside points should be non-negative"
     @assert offside <= div(derivative_order + approximation_order - 1,2) "Number of offside points should not exceed the primary wind points"
@@ -230,7 +230,7 @@ end
 # TODO implement the non-uniform grid
 function UpwindDifference{N}(derivative_order::Int,
                           approximation_order::Int, dx::AbstractVector{T},
-                          len::Int, offside::Int, coeff_func=nothing) where {T<:Real,N}
+                          len::Int, coeff_func=nothing; offside::Int=0) where {T<:Real,N}
 
     @assert offside > -1 "Number of offside points should be non-negative"
     @assert offside <= div(derivative_order + approximation_order - 1,2) "Number of offside points should not exceed the primary wind points"
@@ -287,7 +287,7 @@ function UpwindDifference{N}(derivative_order::Int,
 end
 
 CenteredDifference(args...) = CenteredDifference{1}(args...)
-UpwindDifference(args...) = UpwindDifference{1}(args...)
+UpwindDifference(args...;kwargs...) = UpwindDifference{1}(args...;kwargs...)
 nonlinear_diffusion(args...) = nonlinear_diffusion{1}(args...)
 nonlinear_diffusion!(args...) = nonlinear_diffusion!{1}(args...)
 use_winding(A::DerivativeOperator{T,N,Wind}) where {T,N,Wind} = Wind

test/BasicSDOExamples.jl

@@ -32,10 +32,10 @@ function DEO_negative_drift(pi_profit, params)
     dx = params.x[2] - params.x[1]
     # discretize L = ρ - μ D_x - σ^2 / 2 D_xx
     # subject to reflecting barriers at 0 and 1
-    L1 = UpwindDifference(1,1,dx,params.M,0,1.)
+    L1 = UpwindDifference(1,1,dx,params.M,1.)
     L2 = CenteredDifference(2,2,dx,params.M)
     Q = Neumann0BC(dx, 1)
-    L₁₋bc = -1. .* Array(UpwindDifference(1,1,dx,params.M,0,-1.) * Q)[1]
+    L₁₋bc = -1. .* Array(UpwindDifference(1,1,dx,params.M,-1.) * Q)[1]
     # Here Array(A::GhostDerivativeOperator) will return a tuple of the linear part
     # and the affine part of the operator A, hence we index Array(µ*L1*Q).
     # The operators in this example are purely linear, so we don't worry about Array(µ*L1*Q)[2]
@@ -72,7 +72,7 @@ function DEO_positive_drift(pi_profit, params)
     dx = params.x[2] - params.x[1]
     # discretize L = ρ - μ D_x - σ^2 / 2 D_xx
     # subject to reflecting barriers at 0 and 1
-    L1 = UpwindDifference(1,1,dx,params.M,0,1.0)
+    L1 = UpwindDifference(1,1,dx,params.M,1.0)
     L2 = CenteredDifference(2,2,dx,params.M)
     Q = Neumann0BC(dx, 1)
     # Here Array(A::GhostDerivativeOperator) will return a tuple of the linear part
@@ -114,7 +114,7 @@ function DEO_state_dependent_drift(pi_profit, μ, params)
     # discretize L = ρ - μ D_x - σ^2 / 2 D_xx
     # subject to reflecting barriers at 0 and 1
     drift = μ.(params.x)
-    L1 = UpwindDifference(1,1,dx,params.M,0,drift)
+    L1 = UpwindDifference(1,1,dx,params.M,drift)
     L2 = CenteredDifference(2,2,dx,params.M)
     Q = Neumann0BC(dx, 1)
     # Here Array(A::GhostDerivativeOperator) will return a tuple of the linear part
@@ -166,7 +166,7 @@ end=#
 function DEO_absorbing_bc(pi_profit, params)
     dx = params.x[2] - params.x[1]
 
-    L1 = UpwindDifference(1,1,dx,params.M,0,params.μ)
+    L1 = UpwindDifference(1,1,dx,params.M,params.μ)
     L2 = CenteredDifference(2,2,dx,params.M)
     # RobinBC(l::NTuple{3,T}, r::NTuple{3,T}, dx::T, order = 1)
     # The variables in l are [αl, βl, γl], and correspond to a BC of the form αl*u(0) + βl*u'(0) = γl
@@ -235,7 +235,7 @@ end=#
 function DEO_Solve_KFE(params)
     dx = params.x[2] - params.x[1]
 
-    L1 = UpwindDifference(1,1,dx,params.M,0,-params.μ)
+    L1 = UpwindDifference(1,1,dx,params.M,-params.μ)
     # L2l = UpwindDifference(2,2,dx,params.M,
     #                          vcat(-1.,zeros(params.M-1)))
     # L2r = UpwindDifference(2,2,dx,params.M,

test/KdV.jl

@@ -19,7 +19,7 @@ using DiffEqOperators, OrdinaryDiffEq, LinearAlgebra
     # const temp = zeros(size(x));
 
     # A = CenteredDifference(1,2,Δx,length(x),:Dirichlet0,:Dirichlet0);
-    A = UpwindDifference{Float64}(1,3,Δx,length(x),0,-1);
+    A = UpwindDifference{Float64}(1,3,Δx,length(x),-1);
     # C = CenteredDifference(3,2,Δx,length(x),:Dirichlet0,:Dirichlet0);
     #C = UpwindDifference{Float64}(3,3,Δx,length(x),-1);
 

test/bc_coeff_compositions.jl

@@ -50,7 +50,7 @@ end
     N = 20
     L = CenteredDifference(4, 4, dx, N)
     L2 = CenteredDifference(2,4, dx, N)
-    L1 = UpwindDifference(1, 1, dx, N, 0, 1.)
+    L1 = UpwindDifference(1, 1, dx, N, 1.)
 
     function coeff_func(du,u,p,t)
         du .= u
@@ -111,7 +111,7 @@ end
     # Test for consistency of c*GhostDerivativeOperator*u when c is a vector
     c = rand(N)
     L = CenteredDifference(4, 4, dx, N)
-    L1 = UpwindDifference(1, 1, 1., N, 0, 1.)
+    L1 = UpwindDifference(1, 1, 1., N, 1.)
     A1 = L1 * Q
     cA = c * A
     cL = c * L
@@ -182,7 +182,7 @@ end
     dx = rand(N + 2)
 
     Q = RobinBC((al, bl, cl), (ar, br, cr), dx)
-    L = UpwindDifference(1, 1, dx, N + 1, 0, 1.)
+    L = UpwindDifference(1, 1, dx, N + 1, 1.)
     L2 = CenteredDifference(2, 2, dx, N)
     L4 = CenteredDifference(4, 4, dx, N - 2)
 

test/coefficient_functions.jl

@@ -46,12 +46,12 @@ end
     # Set up operators to test construction with different coeff_func
     vec_op = Vector{DerivativeOperator}(undef,0)
     dxv = [1.4, 1.1, 2.3, 3.6, 1.5]
-    push!(vec_op, UpwindDifference(1, 1, 1., 3, 0, 1.))
-    push!(vec_op, UpwindDifference(1, 1, 1., 3, 0, [1., 2.25, 3.5]))
-    push!(vec_op, UpwindDifference(1, 1, 1., 3, 0, cos))
-    push!(vec_op, UpwindDifference(1, 1, dxv, 3, 0, 1.))
-    push!(vec_op, UpwindDifference(1, 1, dxv, 3, 0, [1., 2.25, 3.5]))
-    push!(vec_op, UpwindDifference(1, 1, dxv, 3, 0, cos))
+    push!(vec_op, UpwindDifference(1, 1, 1., 3, 1.))
+    push!(vec_op, UpwindDifference(1, 1, 1., 3, [1., 2.25, 3.5]))
+    push!(vec_op, UpwindDifference(1, 1, 1., 3, cos))
+    push!(vec_op, UpwindDifference(1, 1, dxv, 3, 1.))
+    push!(vec_op, UpwindDifference(1, 1, dxv, 3, [1., 2.25, 3.5]))
+    push!(vec_op, UpwindDifference(1, 1, dxv, 3, cos))
 
 
     vec_op_ans = Vector{Any}(undef,0)
@@ -63,7 +63,7 @@ end
     push!(vec_op_ans, ones(3))
 
     # Check constructors
-    @test UpwindDifference(1, 1, 1., 3,0).coefficients + ones(3) - ones(3) ≈ zeros(3)
+    @test UpwindDifference(1, 1, 1., 3).coefficients + ones(3) - ones(3) ≈ zeros(3)
     @test CenteredDifference(2, 2, 1., 3, 0.).coefficients + ones(3) - ones(3) ≈ zeros(3)
     for (L, op_ans) in zip(vec_op, vec_op_ans)
         @test L.coefficients ≈ op_ans

test/derivative_operators_interface.jl

@@ -329,8 +329,8 @@ end
 
 @testset "Left-multiplying operators with a vector of coefficients" begin
     A = CenteredDifference(2, 2, 1., 3)
-    B = UpwindDifference(1, 1, 1., 3, 0, 1.)
-    C = UpwindDifference(1, 1, 1., 3, 0, [2., 3., 4.])
+    B = UpwindDifference(1, 1, 1., 3, 1.)
+    C = UpwindDifference(1, 1, 1., 3, [2., 3., 4.])
     c = [1., 1., 3.]
     cA =  c * A
     cB =  c * B

test/heat_eqn.jl

@@ -17,7 +17,7 @@ using OrdinaryDiffEq
     end
 
     # UpwindDifference with equal no. of primay wind and offside points should behave like a CenteredDifference
-    A2 = UpwindDifference(2,1,2π/511,512,1,1);
+    A2 = UpwindDifference(2,1,2π/511,512,1,offside=1);
     step(u,p,t) = A2*bc*u
     heat_eqn = ODEProblem(step, u0, (0.,10.))
     soln = solve(heat_eqn,Tsit5(),dense=false,tstops=0:0.01:10)
@@ -52,7 +52,7 @@ end
     end
 
     # UpwindDifference with equal no. of primay wind and offside points should behave like a CenteredDifference
-    A2 = UpwindDifference(2,1,dx,N,1,1)
+    A2 = UpwindDifference(2,1,dx,N,1,offside=1)
     step(u,p,t) = A2*bc*u
     heat_eqn = ODEProblem(step, u0, (0.,10.))
     soln = solve(heat_eqn,Tsit5(),dense=false,tstops=0:0.01:10)
@@ -92,7 +92,7 @@ end
     end
 
     # UpwindDifference with equal no. of primay wind and offside points should behave like a CenteredDifference
-    A2 = UpwindDifference(2,1,dx,N,1,1);
+    A2 = UpwindDifference(2,1,dx,N,1,offside=1);
     step(u,p,t) = A2*bc*u
     heat_eqn = ODEProblem(step, u0, (0.,10.));
     soln = solve(heat_eqn,Tsit5(),dense=false,tstops=0:0.01:10);

test/lcp.jl

@@ -31,7 +31,7 @@ function LCP_objects(sp)
     # construct operator and non-operator LCP objects
     BC1 = RobinBC((0., 1., 0.), (0., 1., 0.), grid[2] - grid[1], 1) # for first-derivative
     BC2 = RobinBC((0., 1., 0.), (0., 1., 0.), grid[2] - grid[1], 1) # for second-derivative
-    L1 = UpwindDifference(1, 1, grid[2] - grid[1], M, 0, μ) * BC1
+    L1 = UpwindDifference(1, 1, grid[2] - grid[1], M, μ) * BC1
     L2 = σ^2/2 * CenteredDifference(2, 2, grid[2] - grid[1], M) * BC2
     S_vec = S.(grid)
     u_vec = u.(grid)

test/lcp_split.jl

@@ -19,7 +19,7 @@ function LCP_split(S_)
 
     # construct operator and non-operator LCP objects
     BC = RobinBC((0., 1., 0.), (0., 1., 0.), x[2] - x[1], 1)
-    L1 = UpwindDifference(1, 1, x[2] - x[1], M, 0, map(t -> μ1(t), x)) * BC
+    L1 = UpwindDifference(1, 1, x[2] - x[1], M, map(t -> μ1(t), x)) * BC
     L2 = σ^2 / 2 * CenteredDifference(2, 2, x[2] - x[1], M) * BC
     u_vec = u1.(x)