Skip to content
This repository was archived by the owner on Jul 19, 2023. It is now read-only.

Commit fb77f3b

Browse files
committed
Updated Readme
1 parent 53904ed commit fb77f3b

File tree

1 file changed

+3
-42
lines changed

1 file changed

+3
-42
lines changed

README.md

Lines changed: 3 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,9 @@
66
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](http://diffeqoperators.sciml.ai/dev/)
77

88
DiffEqOperators.jl is a package for finite difference discretization of partial
9-
differential equations. It serves two purposes:
9+
differential equations. It allows building fast lazy operators for high order non-uniform finite differences in an arbitrary number of dimensions, including vector calculus operators.
1010

11-
1. Building fast lazy operators for high order non-uniform finite differences.
12-
2. Automated finite difference discretization of symbolically-defined PDEs.
13-
14-
#### Note: (2) is still a work in progress!
11+
For automatic Method of Lines discretization of PDEs, better suited to nonlinear systems of equations and more complex boundary conditions, please see [MethodOfLines.jl](https://www.github.com/SciML/MethodOfLines.jl)
1512

1613
For the operators, both centered and
1714
[upwind](https://en.wikipedia.org/wiki/Upwind_scheme) operators are provided,
@@ -29,43 +26,7 @@ For information on using the package,
2926
[in-development documentation](https://diffeqoperators.sciml.ai/dev/) for the version of
3027
the documentation which contains the unreleased features.
3128

32-
## Example 1: Automated Finite Difference Solution to the Heat Equation
33-
34-
```julia
35-
using OrdinaryDiffEq, ModelingToolkit, DiffEqOperators, DomainSets
36-
37-
# Parameters, variables, and derivatives
38-
@parameters t x
39-
@variables u(..)
40-
Dt = Differential(t)
41-
Dxx = Differential(x)^2
42-
43-
# 1D PDE and boundary conditions
44-
eq = Dt(u(t,x)) ~ Dxx(u(t,x))
45-
bcs = [u(0,x) ~ cos(x),
46-
u(t,0) ~ exp(-t),
47-
u(t,Float64(pi)) ~ -exp(-t)]
48-
49-
# Space and time domains
50-
domains = [t Interval(0.0,1.0),
51-
x Interval(0.0,Float64(pi))]
52-
53-
# PDE system
54-
@named pdesys = PDESystem(eq,bcs,domains,[t,x],[u(t,x)])
55-
56-
# Method of lines discretization
57-
dx = 0.1
58-
order = 2
59-
discretization = MOLFiniteDifference([x=>dx],t;centered_order=order)
60-
61-
# Convert the PDE problem into an ODE problem
62-
prob = discretize(pdesys,discretization)
63-
64-
# Solve ODE problem
65-
sol = solve(prob,Tsit5(),saveat=0.1)
66-
```
67-
68-
## Example 2: Finite Difference Operator Solution for the Heat Equation
29+
## Example 1: Finite Difference Operator Solution for the Heat Equation
6930

7031
```julia
7132
using DiffEqOperators, OrdinaryDiffEq

0 commit comments

Comments
 (0)