Developing A New Problem
New problems should be defined for new types of differential equations, new partial differential equations, and special subclasses of differential equations for which solvers can dispatch on for better performance (one such subclass are
MassMatrixODEProblem which is a
DAEProblem, but methods can specialize on the specific structure).
To develop a new problem, you need to make a new
DEProblem and a new
DESolution. These types belong in DiffEqBase and should be exported. The
DEProblem type should hold all of the mathematical information about the problem (including all of the meshing information in both space and time), and the
DESolution should hold all of the information for the solution. Then all that is required is to define a
solve(::DEProblem,alg;kwargs) which takes in the problem and returns a solution.
If the problem makes sense in a heirarchy, one should define a promotion structure. For example,
DAEProblems, and so by defining this structure methods written for DAEs can solve ODEs by promotion (such as how
DASSL provides a BDF method).
To add plotting functionality, add a plot recipe for the solution type. For testing one should create a separate
DETestSolution which holds the analytical solution, and/or extend
appxtrue! in DiffEqDevTools for error analysis. Then to check that the algorithm works, add a dispatch for
test_convergence which makes a
ConvergenceSimulation type. This type already has a plot recipe, so plotting functionality will already be embedded. This requires that your problem can take in a true solution, and has a field
errors which is a dictionary of symbols for the different error estimates (L2,L infinity, etc.)
After these steps, update the documentation to include the new problem types and the new associated solvers.