xref: /petsc/doc/changes/dev.md (revision 18aa8208e19388fe287401dd8546d7c1e1329f95)
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- Add support for MUMPS out-of-core facility with the option `-mat_mumps_ooc_tmpdir <dir>` and new functions `MatMumpsSetOocTmpDir()`, `MatMumpsGetOocTmpDir()`
77
78```{rubric} KSP:
79```
80
81- Remove `KSPHPDDMPrecision` in favor of `PetscPrecision`
82
83```{rubric} SNES:
84```
85
86- Change the `destroy()` function argument of `SNESSetConvergenceTest()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
87- Add `SNESSetObjectiveDomainError()`
88- Change `SNES_DIVERGED_FNORM_NAN` to `SNES_DIVERGED_FUNCTION_NANORINF`
89- Add `SNES_DIVERGED_OBJECTIVE_NANORINF`
90- Add `SNES_DIVERGED_OBJECTIVE_DOMAIN`
91- Add developer functions `SNESCheckFunctionDomainError()`, `SNESLineSearchCheckFunctionDomainError()`, `SNESCheckObjectiveDomainError()`, `SNESLineSearchCheckObjectiveDomainError()`, `SNESCheckJacobianDomainError()`, and `SNESLineSearchCheckJacobianDomainError()`
92
93```{rubric} SNESLineSearch:
94```
95
96```{rubric} TS:
97```
98
99- Add `TSPseudoComputeFunction()` to get nonlinear residual while avoiding recalculation if possible
100- Remove unused `TSPseudoVerifyTimeStepDefault()`
101- Remove `TSPseudoComputeTimeStep()` and `TSPseudoVerifyTimeStep()`
102- Change the `destroy()` function argument of `TSTrajectorySetTransform()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
103- Correct option `-ts_max_reject` to `-ts_max_step_rejections`
104- Correct option `-ts_dt` to `-ts_time_step`
105
106```{rubric} TAO:
107```
108
109```{rubric} PetscRegressor:
110```
111
112```{rubric} DM/DA:
113```
114
115-  Change the final argument of `DMShellSetDestroyContext()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
116
117```{rubric} DMSwarm:
118```
119
120```{rubric} DMPlex:
121```
122
123- Add `DMPlexVecGetClosureAtDepth()`
124- Add an extra communicator argument to `DMPlexFilter()` to allow extracting local meshes
125- Add `DMPlexGetLETKFLocalizationMatrix` to compute localization weight matrix for LETKF
126
127```{rubric} FE/FV:
128```
129
130```{rubric} DMNetwork:
131```
132
133```{rubric} DMStag:
134```
135
136```{rubric} DT:
137```
138
139```{rubric} Fortran:
140```
141
142- Replace `./configure` option `--with-mpi-f90module-visibility` with `--with-mpi-ftn-module=<mpi or mpi_f08>`
143- Add `PETSC_INT_KIND` and `PETSC_MPIINT_KIND`
144- Fortran code should now use `MPIU_Comm` instead of `MPI_Comm`, and similarly for other MPI types, see section "Fortran and MPI" in the users guide
145
146