xref: /petsc/doc/changes/dev.md (revision a51b1039bd89f6203bcfe231f440503fcfb61387)
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- Change behavior of `-options_left` when set to `true`: it no longer triggers a call to `PetscOptionsView()`
13
14```{rubric} Configure/Build:
15```
16
17- Make `SYCL` a `devicePackage`, i.e., builds `--with-sycl` now have `PETSC_HAVE_DEVICE` defined
18- Add the option `--with-devicelanguage` to compile `PetscDevice` code using either a C or C++ compiler
19- Add `Caliper`, an instrumentation and performance profiling library that can be used to profile `Hypre`.
20
21```{rubric} Sys:
22```
23
24- Add `PetscCallHYPRE()` to check HYPRE error codes and print error messages on failure
25
26
27```{rubric} Event Logging:
28```
29
30- Add two approaches for GPU energy monitoring:  `-log_view_gpu_energy` and `-log_view_gpu_energy_meter`
31- Add API `PetscLogGpuEnergy()`, `PetscLogGpuEnergyMeter()`, `PetscLogGpuEnergyMeterBegin()` and `PetscLogGpuEnergyMeterEnd()` for GPU energy monitoring
32
33```{rubric} PetscViewer:
34```
35
36-  Change the final argument of `PetscViewerGLVisSetFields()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
37
38```{rubric} PetscDraw:
39```
40
41```{rubric} AO:
42```
43
44```{rubric} IS:
45```
46
47```{rubric} VecScatter / PetscSF:
48```
49
50```{rubric} PF:
51```
52
53```{rubric} Vec:
54```
55
56```{rubric} PetscSection:
57```
58
59```{rubric} PetscPartitioner:
60```
61
62```{rubric} Mat:
63```
64
65- Change the `destroy()` function argument of `MatShellSetMatProductOperation()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
66- Remove `MatMissingDiagonal()`. Developers should use `MatGetDiagonalMarkers_SeqXXX()` when the functionality is needed
67- 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
68
69```{rubric} MatCoarsen:
70```
71
72```{rubric} PC:
73```
74
75- 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
76
77```{rubric} KSP:
78```
79
80- Remove `KSPHPDDMPrecision` in favor of `PetscPrecision`
81
82```{rubric} SNES:
83```
84
85- Change the `destroy()` function argument of `SNESSetConvergenceTest()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
86
87```{rubric} SNESLineSearch:
88```
89
90```{rubric} TS:
91```
92
93- Add `TSPseudoComputeFunction()` to get nonlinear residual while avoiding recalculation if possible
94- Remove unused `TSPseudoVerifyTimeStepDefault()`
95- Remove `TSPseudoComputeTimeStep()` and `TSPseudoVerifyTimeStep()`
96- Change the `destroy()` function argument of `TSTrajectorySetTransform()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
97- Correct option `-ts_max_reject` to `-ts_max_step_rejections`
98- Correct option `-ts_dt` to `-ts_time_step`
99
100```{rubric} TAO:
101```
102
103```{rubric} PetscRegressor:
104```
105
106```{rubric} DM/DA:
107```
108
109-  Change the final argument of `DMShellSetDestroyContext()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
110
111```{rubric} DMSwarm:
112```
113
114```{rubric} DMPlex:
115```
116
117- Add `DMPlexVecGetClosureAtDepth()`
118- Add an extra communicator argument to `DMPlexFilter()` to allow extracting local meshes
119
120```{rubric} FE/FV:
121```
122
123```{rubric} DMNetwork:
124```
125
126```{rubric} DMStag:
127```
128
129```{rubric} DT:
130```
131
132```{rubric} Fortran:
133```
134