xref: /petsc/doc/changes/dev.md (revision beb1828f9b2b17010a77caa674e12f55328009ba)
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
61```{rubric} MatCoarsen:
62```
63
64```{rubric} PC:
65```
66
67- 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
68
69```{rubric} KSP:
70```
71
72- Remove `KSPHPDDMPrecision` in favor of `PetscPrecision`
73
74```{rubric} SNES:
75```
76
77-  Change the `destroy()` function argument of `SNESSetConvergenceTest()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
78
79```{rubric} SNESLineSearch:
80```
81
82```{rubric} TS:
83```
84
85-  Change the `destroy()` function argument of `TSTrajectorySetTransform()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
86
87```{rubric} TAO:
88```
89
90```{rubric} PetscRegressor:
91```
92
93```{rubric} DM/DA:
94```
95
96-  Change the final argument of `DMShellSetDestroyContext()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
97
98```{rubric} DMSwarm:
99```
100
101```{rubric} DMPlex:
102```
103
104- Add `DMPlexVecGetClosureAtDepth()`
105
106```{rubric} FE/FV:
107```
108
109```{rubric} DMNetwork:
110```
111
112```{rubric} DMStag:
113```
114
115```{rubric} DT:
116```
117
118```{rubric} Fortran:
119```
120