xref: /petsc/doc/changes/dev.md (revision a51b1039bd89f6203bcfe231f440503fcfb61387)
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
12*a51b1039SEric Chamberland- Change behavior of `-options_left` when set to `true`: it no longer triggers a call to `PetscOptionsView()`
13*a51b1039SEric Chamberland
1495f7d040SSatish Balay```{rubric} Configure/Build:
1595f7d040SSatish Balay```
1695f7d040SSatish Balay
1793d84e17SPierre Jolivet- Make `SYCL` a `devicePackage`, i.e., builds `--with-sycl` now have `PETSC_HAVE_DEVICE` defined
18c95305b8SPierre Jolivet- Add the option `--with-devicelanguage` to compile `PetscDevice` code using either a C or C++ compiler
198fc55d51SJunchao Zhang- Add `Caliper`, an instrumentation and performance profiling library that can be used to profile `Hypre`.
2093d84e17SPierre Jolivet
2195f7d040SSatish Balay```{rubric} Sys:
2295f7d040SSatish Balay```
2395f7d040SSatish Balay
24a333fa2bSZach Atkins- Add `PetscCallHYPRE()` to check HYPRE error codes and print error messages on failure
25a333fa2bSZach Atkins
26a333fa2bSZach Atkins
2795f7d040SSatish Balay```{rubric} Event Logging:
2895f7d040SSatish Balay```
2995f7d040SSatish Balay
305268dc8aSHong Zhang- Add two approaches for GPU energy monitoring:  `-log_view_gpu_energy` and `-log_view_gpu_energy_meter`
315268dc8aSHong Zhang- Add API `PetscLogGpuEnergy()`, `PetscLogGpuEnergyMeter()`, `PetscLogGpuEnergyMeterBegin()` and `PetscLogGpuEnergyMeterEnd()` for GPU energy monitoring
325268dc8aSHong Zhang
3395f7d040SSatish Balay```{rubric} PetscViewer:
3495f7d040SSatish Balay```
3595f7d040SSatish Balay
36e6aa7a3bSBarry Smith-  Change the final argument of `PetscViewerGLVisSetFields()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
37e6aa7a3bSBarry Smith
3895f7d040SSatish Balay```{rubric} PetscDraw:
3995f7d040SSatish Balay```
4095f7d040SSatish Balay
4195f7d040SSatish Balay```{rubric} AO:
4295f7d040SSatish Balay```
4395f7d040SSatish Balay
4495f7d040SSatish Balay```{rubric} IS:
4595f7d040SSatish Balay```
4695f7d040SSatish Balay
4795f7d040SSatish Balay```{rubric} VecScatter / PetscSF:
4895f7d040SSatish Balay```
4995f7d040SSatish Balay
5095f7d040SSatish Balay```{rubric} PF:
5195f7d040SSatish Balay```
5295f7d040SSatish Balay
5395f7d040SSatish Balay```{rubric} Vec:
5495f7d040SSatish Balay```
5595f7d040SSatish Balay
5695f7d040SSatish Balay```{rubric} PetscSection:
5795f7d040SSatish Balay```
5895f7d040SSatish Balay
5995f7d040SSatish Balay```{rubric} PetscPartitioner:
6095f7d040SSatish Balay```
6195f7d040SSatish Balay
6295f7d040SSatish Balay```{rubric} Mat:
6395f7d040SSatish Balay```
6495f7d040SSatish Balay
65cc1eb50dSBarry Smith- Change the `destroy()` function argument of `MatShellSetMatProductOperation()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
66421480d9SBarry Smith- Remove `MatMissingDiagonal()`. Developers should use `MatGetDiagonalMarkers_SeqXXX()` when the functionality is needed
67b0c98d1dSPierre Jolivet- 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
68cc1eb50dSBarry Smith
6995f7d040SSatish Balay```{rubric} MatCoarsen:
7095f7d040SSatish Balay```
7195f7d040SSatish Balay
7295f7d040SSatish Balay```{rubric} PC:
7395f7d040SSatish Balay```
7495f7d040SSatish Balay
75cf053153SJunchao 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
76cf053153SJunchao Zhang
7795f7d040SSatish Balay```{rubric} KSP:
7895f7d040SSatish Balay```
7995f7d040SSatish Balay
801f08b62aSPierre Jolivet- Remove `KSPHPDDMPrecision` in favor of `PetscPrecision`
811f08b62aSPierre Jolivet
8295f7d040SSatish Balay```{rubric} SNES:
8395f7d040SSatish Balay```
8495f7d040SSatish Balay
8512651944SBarry Smith- Change the `destroy()` function argument of `SNESSetConvergenceTest()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
8612651944SBarry Smith
8795f7d040SSatish Balay```{rubric} SNESLineSearch:
8895f7d040SSatish Balay```
8995f7d040SSatish Balay
9095f7d040SSatish Balay```{rubric} TS:
9195f7d040SSatish Balay```
9295f7d040SSatish Balay
930fe2f5c2SJames Wright- Add `TSPseudoComputeFunction()` to get nonlinear residual while avoiding recalculation if possible
94bef8cd95SJames Wright- Remove unused `TSPseudoVerifyTimeStepDefault()`
953e02b344SJames Wright- Remove `TSPseudoComputeTimeStep()` and `TSPseudoVerifyTimeStep()`
96188af4bfSBarry Smith- Change the `destroy()` function argument of `TSTrajectorySetTransform()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
97188af4bfSBarry Smith- Correct option `-ts_max_reject` to `-ts_max_step_rejections`
98188af4bfSBarry Smith- Correct option `-ts_dt` to `-ts_time_step`
9998cba041SBarry Smith
10095f7d040SSatish Balay```{rubric} TAO:
10195f7d040SSatish Balay```
10295f7d040SSatish Balay
10395f7d040SSatish Balay```{rubric} PetscRegressor:
10495f7d040SSatish Balay```
10595f7d040SSatish Balay
10695f7d040SSatish Balay```{rubric} DM/DA:
10795f7d040SSatish Balay```
10895f7d040SSatish Balay
109e6aa7a3bSBarry Smith-  Change the final argument of `DMShellSetDestroyContext()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
110e6aa7a3bSBarry Smith
11195f7d040SSatish Balay```{rubric} DMSwarm:
11295f7d040SSatish Balay```
11395f7d040SSatish Balay
11495f7d040SSatish Balay```{rubric} DMPlex:
11595f7d040SSatish Balay```
11695f7d040SSatish Balay
11744a422c4SJames Wright- Add `DMPlexVecGetClosureAtDepth()`
11871f1c950SStefano Zampini- Add an extra communicator argument to `DMPlexFilter()` to allow extracting local meshes
11944a422c4SJames Wright
12095f7d040SSatish Balay```{rubric} FE/FV:
12195f7d040SSatish Balay```
12295f7d040SSatish Balay
12395f7d040SSatish Balay```{rubric} DMNetwork:
12495f7d040SSatish Balay```
12595f7d040SSatish Balay
12695f7d040SSatish Balay```{rubric} DMStag:
12795f7d040SSatish Balay```
12895f7d040SSatish Balay
12995f7d040SSatish Balay```{rubric} DT:
13095f7d040SSatish Balay```
13195f7d040SSatish Balay
13295f7d040SSatish Balay```{rubric} Fortran:
13395f7d040SSatish Balay```
134