xref: /petsc/doc/changes/dev.md (revision 421480d92be24cdb9933c60510b8e175c0a8d034)
1# Changes: Development
2
3% STYLE GUIDELINES:
4% * Capitalize sentences
5% * Use imperative, e.g., Add, Improve, Change, etc.
6% * Don't use a period (.) at the end of entries
7% * If multiple sentences are needed, use a period or semicolon to divide sentences, but not at the end of the final sentence
8
9```{rubric} General:
10```
11
12```{rubric} Configure/Build:
13```
14
15- Make `SYCL` a `devicePackage`, i.e., builds `--with-sycl` now have `PETSC_HAVE_DEVICE` defined
16- Add the option `--with-devicelanguage` to compile `PetscDevice` code using either a C or C++ compiler
17
18```{rubric} Sys:
19```
20
21```{rubric} Event Logging:
22```
23
24- Add two approaches for GPU energy monitoring:  `-log_view_gpu_energy` and `-log_view_gpu_energy_meter`
25- Add API `PetscLogGpuEnergy()`, `PetscLogGpuEnergyMeter()`, `PetscLogGpuEnergyMeterBegin()` and `PetscLogGpuEnergyMeterEnd()` for GPU energy monitoring
26
27```{rubric} PetscViewer:
28```
29
30-  Change the final argument of `PetscViewerGLVisSetFields()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
31
32```{rubric} PetscDraw:
33```
34
35```{rubric} AO:
36```
37
38```{rubric} IS:
39```
40
41```{rubric} VecScatter / PetscSF:
42```
43
44```{rubric} PF:
45```
46
47```{rubric} Vec:
48```
49
50```{rubric} PetscSection:
51```
52
53```{rubric} PetscPartitioner:
54```
55
56```{rubric} Mat:
57```
58
59- Change the `destroy()` function argument of `MatShellSetMatProductOperation()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
60- Remove `MatMissingDiagonal()`. Developers should use `MatGetDiagonalMarkers_SeqXXX()` when the functionality is needed
61
62```{rubric} MatCoarsen:
63```
64
65```{rubric} PC:
66```
67
68- Add multi-precision support for MUMPS. One could use `-pc_precision <single, double>` to set the precision to be used by MUMPS, which can be different from `PetscScalar`'s precision
69
70```{rubric} KSP:
71```
72
73- Remove `KSPHPDDMPrecision` in favor of `PetscPrecision`
74
75```{rubric} SNES:
76```
77
78-  Change the `destroy()` function argument of `SNESSetConvergenceTest()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
79
80```{rubric} SNESLineSearch:
81```
82
83```{rubric} TS:
84```
85
86-  Change the `destroy()` function argument of `TSTrajectorySetTransform()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
87
88```{rubric} TAO:
89```
90
91```{rubric} PetscRegressor:
92```
93
94```{rubric} DM/DA:
95```
96
97-  Change the final argument of `DMShellSetDestroyContext()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
98
99```{rubric} DMSwarm:
100```
101
102```{rubric} DMPlex:
103```
104
105- Add `DMPlexVecGetClosureAtDepth()`
106
107```{rubric} FE/FV:
108```
109
110```{rubric} DMNetwork:
111```
112
113```{rubric} DMStag:
114```
115
116```{rubric} DT:
117```
118
119```{rubric} Fortran:
120```
121