Skip to content

Commit 4cbf4b2

Browse files
committed
Updated Readme
1 parent 2a982ea commit 4cbf4b2

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,24 @@ Feature requests and issues welcome.
99
discretization = MOLFiniteDifference(dxs,
1010
<your choice of continuous variable, usually time>;
1111
upwind_order = <currently hard coded to 1>,
12-
centered_order = <currently hard coded to 2>,
12+
approx_order = Order of derivative approximation, starting from 2
1313
grid_align = your grid type choice>)
1414
prob = discretize(pdesys, discretization)
1515
```
1616
Where `dxs` is a vector of pairs of parameters to the grid step in this dimension, i.e. `[x=>0.2, y=>0.1]`
1717

1818
Note that the second argument to `MOLFiniteDifference` is optional, all parameters can be discretized if all boundary conditions are specified
1919

20-
Currently supported grid types: `center_align` and `edge_align`
20+
Currently supported grid types: `center_align` and `edge_align`. Edge align will give better accuracy with Neumann Boundary conditions.
2121

2222
`center_align`: naive grid, starting from lower boundary, ending on upper boundary with step of `dx`
2323

2424
`edge_align`: offset grid, set halfway between the points that would be generated with center_align, with extra points at either end that are above and below the supremum and infimum by `dx/2`.
2525

26-
Currently boundary conditions defined in terms of derivatives at the boundary are unsupported above 1 discretized dimension. Periodic conditions are also unsupported.
26+
Currently Periodic boundary conditions are unsupported
2727

2828
## Coming soon:
29-
- Arbitrary approximation order
29+
- Automatic up/downwinding for odd order derivatives
3030
- Above mentioned unsupported boundary conditions supported
3131

3232
## Full Example:

0 commit comments

Comments
 (0)