xref: /petsc/doc/changes/dev.md (revision 2a1887a77e7b2c6e00dd0ba96d1387c839460237)
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- Change `MatSetOption(A, MAT_HERMITIAN, PETSC_TRUE)` for `MatSBAIJ` to no longer automatically set the option `MAT_SYMMETRIC` to `PETSC_FALSE`. It is now the duty of the user to call `MatSetOption(A, MAT_SYMMETRIC, PETSC_FALSE)` if a `MatSBAIJ` is Hermitian but not symmetric
65
66```{rubric} MatCoarsen:
67```
68
69```{rubric} PC:
70```
71
72- 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
73
74```{rubric} KSP:
75```
76
77- Remove `KSPHPDDMPrecision` in favor of `PetscPrecision`
78
79```{rubric} SNES:
80```
81
82- Change the `destroy()` function argument of `SNESSetConvergenceTest()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
83
84```{rubric} SNESLineSearch:
85```
86
87```{rubric} TS:
88```
89
90- Add `TSPseudoComputeFunction()` to get nonlinear residual while avoiding recalculation if possible
91- Remove unused `TSPseudoVerifyTimeStepDefault()`
92- Remove `TSPseudoComputeTimeStep()` and `TSPseudoVerifyTimeStep()`
93- Change the `destroy()` function argument of `TSTrajectorySetTransform()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
94- Correct option `-ts_max_reject` to `-ts_max_step_rejections`
95- Correct option `-ts_dt` to `-ts_time_step`
96
97```{rubric} TAO:
98```
99
100```{rubric} PetscRegressor:
101```
102
103```{rubric} DM/DA:
104```
105
106-  Change the final argument of `DMShellSetDestroyContext()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
107
108```{rubric} DMSwarm:
109```
110
111```{rubric} DMPlex:
112```
113
114- Add `DMPlexVecGetClosureAtDepth()`
115- Add an extra communicator argument to `DMPlexFilter()` to allow extracting local meshes
116
117```{rubric} FE/FV:
118```
119
120```{rubric} DMNetwork:
121```
122
123```{rubric} DMStag:
124```
125
126```{rubric} DT:
127```
128
129```{rubric} Fortran:
130```
131