xref: /petsc/doc/changes/dev.md (revision 418fb43b50673c8dcaa7cccd4409f0faf842ef3b)
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- Add `PetscCallHYPRE()` to check HYPRE error codes and print error messages on failure
22
23
24```{rubric} Event Logging:
25```
26
27- Add two approaches for GPU energy monitoring:  `-log_view_gpu_energy` and `-log_view_gpu_energy_meter`
28- Add API `PetscLogGpuEnergy()`, `PetscLogGpuEnergyMeter()`, `PetscLogGpuEnergyMeterBegin()` and `PetscLogGpuEnergyMeterEnd()` for GPU energy monitoring
29
30```{rubric} PetscViewer:
31```
32
33-  Change the final argument of `PetscViewerGLVisSetFields()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
34
35```{rubric} PetscDraw:
36```
37
38```{rubric} AO:
39```
40
41```{rubric} IS:
42```
43
44```{rubric} VecScatter / PetscSF:
45```
46
47```{rubric} PF:
48```
49
50```{rubric} Vec:
51```
52
53```{rubric} PetscSection:
54```
55
56```{rubric} PetscPartitioner:
57```
58
59```{rubric} Mat:
60```
61
62- Change the `destroy()` function argument of `MatShellSetMatProductOperation()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
63- Remove `MatMissingDiagonal()`. Developers should use `MatGetDiagonalMarkers_SeqXXX()` when the functionality is needed
64
65```{rubric} MatCoarsen:
66```
67
68```{rubric} PC:
69```
70
71- 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
72
73```{rubric} KSP:
74```
75
76- Remove `KSPHPDDMPrecision` in favor of `PetscPrecision`
77
78```{rubric} SNES:
79```
80
81-  Change the `destroy()` function argument of `SNESSetConvergenceTest()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
82
83```{rubric} SNESLineSearch:
84```
85
86```{rubric} TS:
87```
88
89-  Change the `destroy()` function argument of `TSTrajectorySetTransform()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
90
91```{rubric} TAO:
92```
93
94```{rubric} PetscRegressor:
95```
96
97```{rubric} DM/DA:
98```
99
100-  Change the final argument of `DMShellSetDestroyContext()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
101
102```{rubric} DMSwarm:
103```
104
105```{rubric} DMPlex:
106```
107
108- Add `DMPlexVecGetClosureAtDepth()`
109
110```{rubric} FE/FV:
111```
112
113```{rubric} DMNetwork:
114```
115
116```{rubric} DMStag:
117```
118
119```{rubric} DT:
120```
121
122```{rubric} Fortran:
123```
124