Merge pull request #16 from tmigot/add-export

tmigot · web-flow · commit 04930b91f105 · 2021-10-09T11:36:22.000-04:00
Add export
diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
 # PDEOptimizationProblems
 
-A list of optimization problems with ODE/PDE in the constraints model and discretized using [Gridap.jl]() and [PDENLPModels.jl]().
+A list of optimization problems with ODE/PDE in the constraints model and discretized using [Gridap.jl](https://github.com/gridap/Gridap.jl) and [PDENLPModels.jl](https://github.com/JuliaSmoothOptimizers/PDENLPModels.jl).
 
 The list of problems can be accessed as a string
 ```
-PDEOptimizationsProblems.problems
+PDEOptimizationsProblems.problems # or setdiff(names(PDEOptimizationProblems), [:PDEOptimizationProblems])
 ```
 and each problem can be accessed as follows
 ```
diff --git a/src/apinene.jl b/src/apinene.jl
@@ -1,3 +1,5 @@
+export apinene
+
 # Isometrization of α-pinene COPS Problem v.0.3.1
 # https://www.mcs.anl.gov/~more//cops/cops3.pdf
 function apinene(args...; n = 400, kwargs...)
diff --git a/src/bearing.jl b/src/bearing.jl
@@ -1,3 +1,5 @@
+export bearing
+
 # Journal Bearing COPS Problem v.0.3.1
 # https://www.mcs.anl.gov/~more//cops/cops3.pdf
 # n= 50, 75, 100
diff --git a/src/burger1d.jl b/src/burger1d.jl
@@ -1,4 +1,4 @@
-export Burger1d
+export burger1d
 
 """
 `Burger1d(;n :: Int = 512, kwargs...)`
diff --git a/src/burger1d_param.jl b/src/burger1d_param.jl
@@ -1,3 +1,5 @@
+export burger1d_param
+
 function burger1d_param(args...; n = 512, kwargs...)
   domain = (0, 1)
   partition = n
diff --git a/src/catmix.jl b/src/catmix.jl
@@ -1,3 +1,5 @@
+export catmix
+
 # Catalyst Mixing COPS Problem v.0.3.1
 # https://www.mcs.anl.gov/~more//cops/cops3.pdf
 # n=100, 200, 400
diff --git a/src/cellincrease.jl b/src/cellincrease.jl
@@ -1,3 +1,5 @@
+export cellincrease
+
 """
 Mairet, F., & Bayen, T. (2021). The promise of dawn: microalgae photoacclimation as an optimal control problem of resource allocation. Journal of Theoretical Biology, 515, 110597.
 
diff --git a/src/cellincrease_MichaelisMenten.jl b/src/cellincrease_MichaelisMenten.jl
@@ -1,3 +1,5 @@
+export cellincrease_MichaelisMenten
+
 """
 Mairet, F., & Bayen, T. (2021). The promise of dawn: microalgae photoacclimation as an optimal control problem of resource allocation. Journal of Theoretical Biology, 515, 110597.
 
diff --git a/src/channel.jl b/src/channel.jl
@@ -1,3 +1,5 @@
+export channel
+
 # Isometrization of Flow in a Channel COPS Problem v.0.3.1
 # https://www.mcs.anl.gov/~more//cops/cops3.pdf
 function channel(args...; n = 400, kwargs...)
diff --git a/src/controlsir.jl b/src/controlsir.jl
@@ -1,3 +1,5 @@
+export controlsir
+
 function controlsir(args...; x0 = [1, 2], n = 10, a = 0.2, b = 0.1, μ = 0.1, T = 1, kwargs...)
   model = CartesianDiscreteModel((0, T), n)
 
diff --git a/src/dirichlet.jl b/src/dirichlet.jl
@@ -1,3 +1,5 @@
+export dirichlet
+
 # Transition States for the Dirichlet Problem COPS Problem v.0.3.1
 # https://www.mcs.anl.gov/~more//cops/cops3.pdf
 # n=10, 20, 40
diff --git a/src/dynamicsir.jl b/src/dynamicsir.jl
@@ -1,3 +1,5 @@
+export dynamicsir
+
 function dynamicsir(args...; x0 = [1, 2], n = 10, T = 1, kwargs...)
   model = CartesianDiscreteModel((0, T), n)
   labels = get_face_labeling(model)
diff --git a/src/gasoil.jl b/src/gasoil.jl
@@ -1,3 +1,5 @@
+export gasoil
+
 # Catalytic Cracking of Gas Oil COPS Problem v.0.3.1
 # https://www.mcs.anl.gov/~more//cops/cops3.pdf
 # n=100, 200, 400
diff --git a/src/glider.jl b/src/glider.jl
@@ -1,3 +1,5 @@
+export glider
+
 # Hang Glider COPS Problem v.0.3.1
 # https://www.mcs.anl.gov/~more//cops/cops3.pdf
 # n=100, 200, 400
diff --git a/src/henon.jl b/src/henon.jl
@@ -1,3 +1,5 @@
+export henon
+
 # Transition States for the Henon Problem COPS Problem v.0.3.1
 # https://www.mcs.anl.gov/~more//cops/cops3.pdf
 # n=10, 20, 40
diff --git a/src/ignition.jl b/src/ignition.jl
@@ -1,3 +1,5 @@
+export ignition
+
 # https://arxiv.org/pdf/2103.14552.pdf
 # Example 2. IGNITION
 # Multilevel Active-Set Trust-Region (MASTR) Method for Bound Constrained Minimization
diff --git a/src/incompressibleNavierStokes.jl b/src/incompressibleNavierStokes.jl
@@ -1,4 +1,4 @@
-export incompressibleNavierStokes
+export incompressiblenavierstokes
 
 """
 
diff --git a/src/inversepoissonproblem2d.jl b/src/inversepoissonproblem2d.jl
@@ -4,7 +4,7 @@
 # min_{u,z}   0.5 ∫_Ω​ |u(x) - ud(x)|^2dx + 0.5 * α * ∫_Ω​ |z|^2
 # s.t.        -∇⋅(z∇u) = h ,   for    x ∈  Ω
 #             u(x) = 0,        for    x ∈ ∂Ω
-export inversePoissonproblem2d
+export inversepoissonproblem2d
 
 """
 
diff --git a/src/lane_emden.jl b/src/lane_emden.jl
@@ -1,3 +1,5 @@
+export lane_emden
+
 # Transition States for the Lane-Emden Problem COPS Problem v.0.3.1
 # https://www.mcs.anl.gov/~more//cops/cops3.pdf
 # n=10, 20, 40
diff --git a/src/membrane.jl b/src/membrane.jl
@@ -1,3 +1,5 @@
+export membrane
+
 """
 https://arxiv.org/pdf/2103.14552.pdf
 Example 1. MEMBRANE
diff --git a/src/methanol.jl b/src/methanol.jl
@@ -1,3 +1,5 @@
+export methanol
+
 # Methanol to Hydrocarbons COPS Problem v.0.3.1
 # https://www.mcs.anl.gov/~more//cops/cops3.pdf
 # n=100, 200, 400
diff --git a/src/minsurf.jl b/src/minsurf.jl
@@ -1,3 +1,5 @@
+export minsurf
+
 # Minimal Surface with Obstacle COPS Problem v.0.3.1
 # https://www.mcs.anl.gov/~more//cops/cops3.pdf
 # n= 50, 75, 100
diff --git a/src/morebv.jl b/src/morebv.jl
@@ -1,3 +1,5 @@
+export morebv
+
 # https://arxiv.org/pdf/2103.14552.pdf
 # Example 3. MOREBV
 # Multilevel Active-Set Trust-Region (MASTR) Method for Bound Constrained Minimization
diff --git a/src/penalizedpoisson.jl b/src/penalizedpoisson.jl
@@ -1,4 +1,4 @@
-export penalizedPoisson
+export penalizedpoisson
 
 """
 Let Ω=(0,1)^2, we solve the unconstrained optimization problem:
diff --git a/src/poisson_with_Neumann_and_Dirichlet.jl b/src/poisson_with_Neumann_and_Dirichlet.jl
@@ -1,3 +1,5 @@
+export poisson_with_Neumann_and_Dirichlet
+
 function poisson_with_Neumann_and_Dirichlet(args...; n::Int = 10, kwargs...)
   #model = DiscreteModelFromFile("https://github.com/gridap/Tutorials/tree/master/models/model.json")
   # model = DiscreteModelFromFile("models/model.json")
diff --git a/src/poissonboltzman2d.jl b/src/poissonboltzman2d.jl
@@ -1,4 +1,4 @@
-export poissonBoltzman2d
+export poissonboltzman2d
 
 """
 
diff --git a/src/poissonmixed.jl b/src/poissonmixed.jl
@@ -1,3 +1,5 @@
+export poissonmixed
+
 ###############################################################################
 #
 # This test case consider the optimization of a parameter in a Poisson equation
diff --git a/src/poissonmixed2.jl b/src/poissonmixed2.jl
@@ -1,3 +1,5 @@
+export poissonmixed2
+
 ###############################################################################
 #
 # This test case consider the optimization of a parameter in a Poisson equation
diff --git a/src/poissonparam.jl b/src/poissonparam.jl
@@ -1,3 +1,5 @@
+export poissonparam
+
 ###############################################################################
 #
 # This test case consider the optimization of a parameter in a Poisson equation
diff --git a/src/robot.jl b/src/robot.jl
@@ -1,3 +1,5 @@
+export robot
+
 # Isometrization of Robot Arm COPS Problem v.0.3.1
 # https://www.mcs.anl.gov/~more//cops/cops3.pdf
 # n=200, 400, 800
diff --git a/src/rocket.jl b/src/rocket.jl
@@ -1,3 +1,5 @@
+export rocket
+
 # Goddard Rocket COPS Problem v.0.3.1
 # https://www.mcs.anl.gov/~more//cops/cops3.pdf
 # n=400, 800, 1600
diff --git a/src/sis.jl b/src/sis.jl
@@ -1,3 +1,5 @@
+export sis
+
 function sis(args...; x0 = [1, 2], n = 10, a = 0.2, b = 0.7, T = 1, kwargs...)
   model = CartesianDiscreteModel((0, T), n)
   labels = get_face_labeling(model)
diff --git a/src/smallestlaplacianeigenvalue.jl b/src/smallestlaplacianeigenvalue.jl
@@ -1,4 +1,4 @@
-export smallestLaplacianeigenvalue
+export smallestlaplacianeigenvalue
 
 """
 `smallestLaplacianeigenvalue(; n :: Int = 10, args...)`
diff --git a/src/steering.jl b/src/steering.jl
@@ -1,3 +1,5 @@
+export steering
+
 # Isometrization of Particle Steering COPS Problem v.0.3.1
 # https://www.mcs.anl.gov/~more//cops/cops3.pdf
 # n=200, 400, 800
diff --git a/src/torebrachistochrone.jl b/src/torebrachistochrone.jl
@@ -1,3 +1,5 @@
+export torebrachistochrone
+
 function torebrachistochrone(args...; n = 3, kwargs...)
   # n est la taille de la discrétisation (entier)
   # le domain au format (t₀, T)
diff --git a/src/torsion.jl b/src/torsion.jl
@@ -1,3 +1,5 @@
+export torsion
+
 # Elastic-Plastic Torsion COPS Problem v.0.3.1
 # https://www.mcs.anl.gov/~more//cops/cops3.pdf
 function torsion(args...; n = 3, kwargs...)
diff --git a/test/runtests.jl b/test/runtests.jl
@@ -5,8 +5,7 @@ using PDEOptimizationProblems
 include("utils.jl")
 
 # Test that every problem can be instantiated.
-for pb in PDEOptimizationProblems.problems
-  prob = Meta.parse(pb)
+for prob in setdiff(names(PDEOptimizationProblems), [:PDEOptimizationProblems])
   print(prob)
   prob_fn = PDEOptimizationProblems.eval(prob)
   nlp = prob_fn(n = 10)
@@ -15,5 +14,5 @@ for pb in PDEOptimizationProblems.problems
   nlp.meta.ncon != 0 && cons(nlp, nlp.meta.x0)
   hess(nlp, nlp.meta.x0, nlp.meta.y0)
   # test meta information
-  meta_sanity(pb)
+  meta_sanity(prob)
 end
diff --git a/test/utils.jl b/test/utils.jl
@@ -6,7 +6,7 @@ function meta_sanity(name)
   nlp = eval(Meta.parse("PDEOptimizationProblems.$(name)(n = $ndef)"))
 
   @show nlp.meta.name, meta[:name]
-  if !(name in ["incompressiblenavierstokes"])
+  if !(name in [:incompressiblenavierstokes])
     @test nlp.meta.nvar == n
     @test nlp.meta.ncon == m
   end

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+export apinene`
	`2`	`+`
`1`	`3`	`# Isometrization of α-pinene COPS Problem v.0.3.1`
`2`	`4`	`# https://www.mcs.anl.gov/~more//cops/cops3.pdf`
`3`	`5`	`function apinene(args...; n = 400, kwargs...)`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+export bearing`
	`2`	`+`
`1`	`3`	`# Journal Bearing COPS Problem v.0.3.1`
`2`	`4`	`# https://www.mcs.anl.gov/~more//cops/cops3.pdf`
`3`	`5`	`# n= 50, 75, 100`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-export Burger1d`
	`1`	`+export burger1d`
`2`	`2`
`3`	`3`	`"""`
`4`	`4`	`Burger1d(;n :: Int = 512, kwargs...)`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+export burger1d_param`
	`2`	`+`
`1`	`3`	`function burger1d_param(args...; n = 512, kwargs...)`
`2`	`4`	`domain = (0, 1)`
`3`	`5`	`partition = n`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+export catmix`
	`2`	`+`
`1`	`3`	`# Catalyst Mixing COPS Problem v.0.3.1`
`2`	`4`	`# https://www.mcs.anl.gov/~more//cops/cops3.pdf`
`3`	`5`	`# n=100, 200, 400`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+export cellincrease`
	`2`	`+`
`1`	`3`	`"""`
`2`	`4`	`Mairet, F., & Bayen, T. (2021). The promise of dawn: microalgae photoacclimation as an optimal control problem of resource allocation. Journal of Theoretical Biology, 515, 110597.`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+export cellincrease_MichaelisMenten`
	`2`	`+`
`1`	`3`	`"""`
`2`	`4`	`Mairet, F., & Bayen, T. (2021). The promise of dawn: microalgae photoacclimation as an optimal control problem of resource allocation. Journal of Theoretical Biology, 515, 110597.`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+export channel`
	`2`	`+`
`1`	`3`	`# Isometrization of Flow in a Channel COPS Problem v.0.3.1`
`2`	`4`	`# https://www.mcs.anl.gov/~more//cops/cops3.pdf`
`3`	`5`	`function channel(args...; n = 400, kwargs...)`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+export controlsir`
	`2`	`+`
`1`	`3`	`function controlsir(args...; x0 = [1, 2], n = 10, a = 0.2, b = 0.1, μ = 0.1, T = 1, kwargs...)`
`2`	`4`	`model = CartesianDiscreteModel((0, T), n)`
`3`	`5`