xref: /petsc/doc/changes/dev.md (revision 3e02b3448362d3c26ed00cb31db2bd3e29f7ca01)
195f7d040SSatish Balay# Changes: Development
295f7d040SSatish Balay
395f7d040SSatish Balay% STYLE GUIDELINES:
495f7d040SSatish Balay% * Capitalize sentences
595f7d040SSatish Balay% * Use imperative, e.g., Add, Improve, Change, etc.
695f7d040SSatish Balay% * Don't use a period (.) at the end of entries
795f7d040SSatish Balay% * If multiple sentences are needed, use a period or semicolon to divide sentences, but not at the end of the final sentence
895f7d040SSatish Balay
995f7d040SSatish Balay```{rubric} General:
1095f7d040SSatish Balay```
1195f7d040SSatish Balay
1295f7d040SSatish Balay```{rubric} Configure/Build:
1395f7d040SSatish Balay```
1495f7d040SSatish Balay
1593d84e17SPierre Jolivet- Make `SYCL` a `devicePackage`, i.e., builds `--with-sycl` now have `PETSC_HAVE_DEVICE` defined
16c95305b8SPierre Jolivet- Add the option `--with-devicelanguage` to compile `PetscDevice` code using either a C or C++ compiler
1793d84e17SPierre Jolivet
1895f7d040SSatish Balay```{rubric} Sys:
1995f7d040SSatish Balay```
2095f7d040SSatish Balay
21a333fa2bSZach Atkins- Add `PetscCallHYPRE()` to check HYPRE error codes and print error messages on failure
22a333fa2bSZach Atkins
23a333fa2bSZach Atkins
2495f7d040SSatish Balay```{rubric} Event Logging:
2595f7d040SSatish Balay```
2695f7d040SSatish Balay
275268dc8aSHong Zhang- Add two approaches for GPU energy monitoring:  `-log_view_gpu_energy` and `-log_view_gpu_energy_meter`
285268dc8aSHong Zhang- Add API `PetscLogGpuEnergy()`, `PetscLogGpuEnergyMeter()`, `PetscLogGpuEnergyMeterBegin()` and `PetscLogGpuEnergyMeterEnd()` for GPU energy monitoring
295268dc8aSHong Zhang
3095f7d040SSatish Balay```{rubric} PetscViewer:
3195f7d040SSatish Balay```
3295f7d040SSatish Balay
33e6aa7a3bSBarry Smith-  Change the final argument of `PetscViewerGLVisSetFields()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
34e6aa7a3bSBarry Smith
3595f7d040SSatish Balay```{rubric} PetscDraw:
3695f7d040SSatish Balay```
3795f7d040SSatish Balay
3895f7d040SSatish Balay```{rubric} AO:
3995f7d040SSatish Balay```
4095f7d040SSatish Balay
4195f7d040SSatish Balay```{rubric} IS:
4295f7d040SSatish Balay```
4395f7d040SSatish Balay
4495f7d040SSatish Balay```{rubric} VecScatter / PetscSF:
4595f7d040SSatish Balay```
4695f7d040SSatish Balay
4795f7d040SSatish Balay```{rubric} PF:
4895f7d040SSatish Balay```
4995f7d040SSatish Balay
5095f7d040SSatish Balay```{rubric} Vec:
5195f7d040SSatish Balay```
5295f7d040SSatish Balay
5395f7d040SSatish Balay```{rubric} PetscSection:
5495f7d040SSatish Balay```
5595f7d040SSatish Balay
5695f7d040SSatish Balay```{rubric} PetscPartitioner:
5795f7d040SSatish Balay```
5895f7d040SSatish Balay
5995f7d040SSatish Balay```{rubric} Mat:
6095f7d040SSatish Balay```
6195f7d040SSatish Balay
62cc1eb50dSBarry Smith-  Change the `destroy()` function argument of `MatShellSetMatProductOperation()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
63cc1eb50dSBarry Smith
6495f7d040SSatish Balay```{rubric} MatCoarsen:
6595f7d040SSatish Balay```
6695f7d040SSatish Balay
6795f7d040SSatish Balay```{rubric} PC:
6895f7d040SSatish Balay```
6995f7d040SSatish Balay
70cf053153SJunchao Zhang- 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
71cf053153SJunchao Zhang
7295f7d040SSatish Balay```{rubric} KSP:
7395f7d040SSatish Balay```
7495f7d040SSatish Balay
751f08b62aSPierre Jolivet- Remove `KSPHPDDMPrecision` in favor of `PetscPrecision`
761f08b62aSPierre Jolivet
7795f7d040SSatish Balay```{rubric} SNES:
7895f7d040SSatish Balay```
7995f7d040SSatish Balay
8012651944SBarry Smith-  Change the `destroy()` function argument of `SNESSetConvergenceTest()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
8112651944SBarry Smith
8295f7d040SSatish Balay```{rubric} SNESLineSearch:
8395f7d040SSatish Balay```
8495f7d040SSatish Balay
8595f7d040SSatish Balay```{rubric} TS:
8695f7d040SSatish Balay```
8795f7d040SSatish Balay
8898cba041SBarry Smith-  Change the `destroy()` function argument of `TSTrajectorySetTransform()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
890fe2f5c2SJames Wright-  Add `TSPseudoComputeFunction()` to get nonlinear residual while avoiding recalculation if possible
90bef8cd95SJames Wright-  Remove unused `TSPseudoVerifyTimeStepDefault()`
91*3e02b344SJames Wright-  Remove `TSPseudoComputeTimeStep()` and `TSPseudoVerifyTimeStep()`
9298cba041SBarry Smith
9395f7d040SSatish Balay```{rubric} TAO:
9495f7d040SSatish Balay```
9595f7d040SSatish Balay
9695f7d040SSatish Balay```{rubric} PetscRegressor:
9795f7d040SSatish Balay```
9895f7d040SSatish Balay
9995f7d040SSatish Balay```{rubric} DM/DA:
10095f7d040SSatish Balay```
10195f7d040SSatish Balay
102e6aa7a3bSBarry Smith-  Change the final argument of `DMShellSetDestroyContext()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
103e6aa7a3bSBarry Smith
10495f7d040SSatish Balay```{rubric} DMSwarm:
10595f7d040SSatish Balay```
10695f7d040SSatish Balay
10795f7d040SSatish Balay```{rubric} DMPlex:
10895f7d040SSatish Balay```
10995f7d040SSatish Balay
11044a422c4SJames Wright- Add `DMPlexVecGetClosureAtDepth()`
11144a422c4SJames Wright
11295f7d040SSatish Balay```{rubric} FE/FV:
11395f7d040SSatish Balay```
11495f7d040SSatish Balay
11595f7d040SSatish Balay```{rubric} DMNetwork:
11695f7d040SSatish Balay```
11795f7d040SSatish Balay
11895f7d040SSatish Balay```{rubric} DMStag:
11995f7d040SSatish Balay```
12095f7d040SSatish Balay
12195f7d040SSatish Balay```{rubric} DT:
12295f7d040SSatish Balay```
12395f7d040SSatish Balay
12495f7d040SSatish Balay```{rubric} Fortran:
12595f7d040SSatish Balay```
126