Mercurial > repos > public > sbplib_julia

annotate TODO.md @ 1616:e41eddc640f3 feature/boundary_conditions

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs
author Vidar Stiernström <vidar.stiernstrom@gmail.com>
date Sun, 09 Jun 2024 17:51:57 -0700
parents 19cdec9c21cb
children 3e9c3986930d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
102
f99320a459ef Add TODO file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
1 # TODO
f99320a459ef Add TODO file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
2
1342
c0c1189c5f2e Clean up grid_refactor.md
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
3 ## Organization
c0c1189c5f2e Clean up grid_refactor.md
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
4 - [ ] Split up Notes.md in several files
102
f99320a459ef Add TODO file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
5
294
9c12d9eb38fd Clean up TODO.txt
Jonatan Werpers <jonatan@werpers.com>
parents: 284
diff changeset
6 ## Coding
1050
396278072f18 Add some notes and clean up TODO.md a little bit
Jonatan Werpers <jonatan@werpers.com>
parents: 1041
diff changeset
7 - [ ] Ändra namn på variabler och funktioner så att det följer style-guide
626
8581610da4f1 Add comment for work on RegionIndices and fix typos
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 606
diff changeset
8 - [ ] Add new Laplace operator to DiffOps, probably named WaveEqOp(?!!?)
294
9c12d9eb38fd Clean up TODO.txt
Jonatan Werpers <jonatan@werpers.com>
parents: 284
diff changeset
9 - [ ] Create a struct that bundles the necessary Tensor operators for solving the wave equation.
379
de4746d6d126 Add some notes and todos
Jonatan Werpers <jonatan@werpers.com>
parents: 332
diff changeset
10 - [ ] Use `@inferred` in a lot of tests.
1050
396278072f18 Add some notes and clean up TODO.md a little bit
Jonatan Werpers <jonatan@werpers.com>
parents: 1041
diff changeset
11 - [ ] Replace `@inferred` tests with a benchmark suite that automatically tests for regressions.
427
1c41f4fd3e61 Add some notes and todos
Jonatan Werpers <jonatan@werpers.com>
parents: 379
diff changeset
12 - [ ] Make sure we are setting tolerances in tests in a consistent way
626
8581610da4f1 Add comment for work on RegionIndices and fix typos
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 606
diff changeset
13 - [ ] Write down some coding guideline or checklist for code conventions. For example i,j,... for indices and I for multi-index
606
8f9b3eac128a Add a bunch of stuff to TODO.md and Notes.md
Jonatan Werpers <jonatan@werpers.com>
parents: 549
diff changeset
14 - [ ] Clean up RegionIndices
8f9b3eac128a Add a bunch of stuff to TODO.md and Notes.md
Jonatan Werpers <jonatan@werpers.com>
parents: 549
diff changeset
15 1. [ ] Write tests for how things should work
8f9b3eac128a Add a bunch of stuff to TODO.md and Notes.md
Jonatan Werpers <jonatan@werpers.com>
parents: 549
diff changeset
16 2. [ ] Update RegionIndices accordingly
8f9b3eac128a Add a bunch of stuff to TODO.md and Notes.md
Jonatan Werpers <jonatan@werpers.com>
parents: 549
diff changeset
17 3. [ ] Fix the rest of the library
626
8581610da4f1 Add comment for work on RegionIndices and fix typos
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 606
diff changeset
18 Should getregion also work for getregion(::Colon,...)
8581610da4f1 Add comment for work on RegionIndices and fix typos
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 606
diff changeset
19 - [ ] Add possibility to create tensor mapping application with `()`, e.g `D1(v) <=> D1*v`?
656
1c3378b26466 Add todo on pretty printing
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 653
diff changeset
20 - [ ] Add custom pretty printing to LazyTensors/SbpOperators to enhance readability of e.g error messages.
1c3378b26466 Add todo on pretty printing
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 653
diff changeset
21 See (https://docs.julialang.org/en/v1/manual/types/#man-custom-pretty-printing)
1050
396278072f18 Add some notes and clean up TODO.md a little bit
Jonatan Werpers <jonatan@werpers.com>
parents: 1041
diff changeset
22 - [ ] Samla noggrannhets- och SBP-ness-tester för alla operatorer på ett ställe
963
52a0ebad0778 Review: Address review comment on placement of exports. Export statements should be placed at the top of the module file. Add todo.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 656
diff changeset
23 - [ ] Move export statements to top of each module
1598
19cdec9c21cb Implement and test sat_tensors for Dirichlet and Neumann conditions
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1413
diff changeset
24 - [ ] Implement apply_transpose for
19cdec9c21cb Implement and test sat_tensors for Dirichlet and Neumann conditions
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1413
diff changeset
25 - [ ] ElementwiseTensorOperation
19cdec9c21cb Implement and test sat_tensors for Dirichlet and Neumann conditions
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1413
diff changeset
26 - [ ] VolumeOperator
19cdec9c21cb Implement and test sat_tensors for Dirichlet and Neumann conditions
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1413
diff changeset
27 - [ ] Laplace
119
8e52a66225d0 Add some Todos
Jonatan Werpers <jonatan@werpers.com>
parents: 102
diff changeset
28
297
dfadc0bafbbd Fix some formatting errors in TODO.md
Jonatan Werpers <jonatan@werpers.com>
parents: 295
diff changeset
29
1050
396278072f18 Add some notes and clean up TODO.md a little bit
Jonatan Werpers <jonatan@werpers.com>
parents: 1041
diff changeset
30 - [ ] Gå igenom alla typ parametrar och kolla om de är motiverade. Både i signaturer och typer, tex D i VariableSecondDerivative. Kan vi använda promote istället?
294
9c12d9eb38fd Clean up TODO.txt
Jonatan Werpers <jonatan@werpers.com>
parents: 284
diff changeset
31 - [ ] Kolla att vi har @inbounds och @propagate_inbounds på rätt ställen
9c12d9eb38fd Clean up TODO.txt
Jonatan Werpers <jonatan@werpers.com>
parents: 284
diff changeset
32 - [ ] Kolla att vi gör boundschecks överallt och att de är markerade med @boundscheck
9c12d9eb38fd Clean up TODO.txt
Jonatan Werpers <jonatan@werpers.com>
parents: 284
diff changeset
33 - [ ] Kolla att vi har @inline på rätt ställen
9c12d9eb38fd Clean up TODO.txt
Jonatan Werpers <jonatan@werpers.com>
parents: 284
diff changeset
34 - [ ] Profilera
1342
c0c1189c5f2e Clean up grid_refactor.md
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
35
c0c1189c5f2e Clean up grid_refactor.md
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
36
c0c1189c5f2e Clean up grid_refactor.md
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
37 ### Grids
c0c1189c5f2e Clean up grid_refactor.md
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
38
c0c1189c5f2e Clean up grid_refactor.md
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
39 - [ ] Multiblock grids
c0c1189c5f2e Clean up grid_refactor.md
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
40 - [ ] Periodic grids
c0c1189c5f2e Clean up grid_refactor.md
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
41 - [ ] Grids with modified boundary closures
1413
410bc321242c Add todo for colon-indexing and remove tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1365
diff changeset
42 - [ ] Support indexing with `:`.
1343
fa3695f634de More clean up of todos and notes
Jonatan Werpers <jonatan@werpers.com>
parents: 1342
diff changeset
43
fa3695f634de More clean up of todos and notes
Jonatan Werpers <jonatan@werpers.com>
parents: 1342
diff changeset
44
fa3695f634de More clean up of todos and notes
Jonatan Werpers <jonatan@werpers.com>
parents: 1342
diff changeset
45 ### Benchmarks
fa3695f634de More clean up of todos and notes
Jonatan Werpers <jonatan@werpers.com>
parents: 1342
diff changeset
46 - [ ] Benchmarks for all grid indexing (focused on allocation)
fa3695f634de More clean up of todos and notes
Jonatan Werpers <jonatan@werpers.com>
parents: 1342
diff changeset
47 - [ ] Benchmarks for indexing of lazy grid functions
fa3695f634de More clean up of todos and notes
Jonatan Werpers <jonatan@werpers.com>
parents: 1342
diff changeset
48 - [ ] Add benchmarks for range type in EquidistantGrid. (LinRange vs StepRange)