xref: /petsc/doc/changes/dev.md (revision 76c6338944e4871467ad7a763eee41b62845c2b0)
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
178fc55d51SJunchao Zhang- Add `Caliper`, an instrumentation and performance profiling library that can be used to profile `Hypre`.
1893d84e17SPierre Jolivet
1995f7d040SSatish Balay```{rubric} Sys:
2095f7d040SSatish Balay```
2195f7d040SSatish Balay
22a333fa2bSZach Atkins- Add `PetscCallHYPRE()` to check HYPRE error codes and print error messages on failure
23a333fa2bSZach Atkins
24a333fa2bSZach Atkins
2595f7d040SSatish Balay```{rubric} Event Logging:
2695f7d040SSatish Balay```
2795f7d040SSatish Balay
285268dc8aSHong Zhang- Add two approaches for GPU energy monitoring:  `-log_view_gpu_energy` and `-log_view_gpu_energy_meter`
295268dc8aSHong Zhang- Add API `PetscLogGpuEnergy()`, `PetscLogGpuEnergyMeter()`, `PetscLogGpuEnergyMeterBegin()` and `PetscLogGpuEnergyMeterEnd()` for GPU energy monitoring
305268dc8aSHong Zhang
3195f7d040SSatish Balay```{rubric} PetscViewer:
3295f7d040SSatish Balay```
3395f7d040SSatish Balay
34e6aa7a3bSBarry Smith-  Change the final argument of `PetscViewerGLVisSetFields()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
35e6aa7a3bSBarry Smith
3695f7d040SSatish Balay```{rubric} PetscDraw:
3795f7d040SSatish Balay```
3895f7d040SSatish Balay
3995f7d040SSatish Balay```{rubric} AO:
4095f7d040SSatish Balay```
4195f7d040SSatish Balay
4295f7d040SSatish Balay```{rubric} IS:
4395f7d040SSatish Balay```
4495f7d040SSatish Balay
4595f7d040SSatish Balay```{rubric} VecScatter / PetscSF:
4695f7d040SSatish Balay```
4795f7d040SSatish Balay
4895f7d040SSatish Balay```{rubric} PF:
4995f7d040SSatish Balay```
5095f7d040SSatish Balay
5195f7d040SSatish Balay```{rubric} Vec:
5295f7d040SSatish Balay```
5395f7d040SSatish Balay
5495f7d040SSatish Balay```{rubric} PetscSection:
5595f7d040SSatish Balay```
5695f7d040SSatish Balay
5795f7d040SSatish Balay```{rubric} PetscPartitioner:
5895f7d040SSatish Balay```
5995f7d040SSatish Balay
6095f7d040SSatish Balay```{rubric} Mat:
6195f7d040SSatish Balay```
6295f7d040SSatish Balay
63cc1eb50dSBarry Smith- Change the `destroy()` function argument of `MatShellSetMatProductOperation()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
64421480d9SBarry Smith- Remove `MatMissingDiagonal()`. Developers should use `MatGetDiagonalMarkers_SeqXXX()` when the functionality is needed
65b0c98d1dSPierre 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
66cc1eb50dSBarry Smith
6795f7d040SSatish Balay```{rubric} MatCoarsen:
6895f7d040SSatish Balay```
6995f7d040SSatish Balay
7095f7d040SSatish Balay```{rubric} PC:
7195f7d040SSatish Balay```
7295f7d040SSatish Balay
73cf053153SJunchao 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
74cf053153SJunchao Zhang
7595f7d040SSatish Balay```{rubric} KSP:
7695f7d040SSatish Balay```
7795f7d040SSatish Balay
781f08b62aSPierre Jolivet- Remove `KSPHPDDMPrecision` in favor of `PetscPrecision`
791f08b62aSPierre Jolivet
8095f7d040SSatish Balay```{rubric} SNES:
8195f7d040SSatish Balay```
8295f7d040SSatish Balay
8312651944SBarry Smith- Change the `destroy()` function argument of `SNESSetConvergenceTest()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
84*76c63389SBarry Smith- Add `SNESSetObjectiveDomainError()`
85*76c63389SBarry Smith- Change `SNES_DIVERGED_FNORM_NAN` to `SNES_DIVERGED_FUNCTION_NANORINF`
86*76c63389SBarry Smith- Add `SNES_DIVERGED_OBJECTIVE_NANORINF`
87*76c63389SBarry Smith- Add `SNES_DIVERGED_OBJECTIVE_DOMAIN`
88*76c63389SBarry Smith- Add developer functions `SNESCheckFunctionDomainError()`, `SNESLineSearchCheckFunctionDomainError()`, `SNESCheckObjectiveDomainError()`, `SNESLineSearchCheckObjectiveDomainError()`, `SNESCheckJacobianDomainError()`, and `SNESLineSearchCheckJacobianDomainError()`
8912651944SBarry Smith
9095f7d040SSatish Balay```{rubric} SNESLineSearch:
9195f7d040SSatish Balay```
9295f7d040SSatish Balay
9395f7d040SSatish Balay```{rubric} TS:
9495f7d040SSatish Balay```
9595f7d040SSatish Balay
960fe2f5c2SJames Wright- Add `TSPseudoComputeFunction()` to get nonlinear residual while avoiding recalculation if possible
97bef8cd95SJames Wright- Remove unused `TSPseudoVerifyTimeStepDefault()`
983e02b344SJames Wright- Remove `TSPseudoComputeTimeStep()` and `TSPseudoVerifyTimeStep()`
99188af4bfSBarry Smith- Change the `destroy()` function argument of `TSTrajectorySetTransform()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
100188af4bfSBarry Smith- Correct option `-ts_max_reject` to `-ts_max_step_rejections`
101188af4bfSBarry Smith- Correct option `-ts_dt` to `-ts_time_step`
10298cba041SBarry Smith
10395f7d040SSatish Balay```{rubric} TAO:
10495f7d040SSatish Balay```
10595f7d040SSatish Balay
10695f7d040SSatish Balay```{rubric} PetscRegressor:
10795f7d040SSatish Balay```
10895f7d040SSatish Balay
10995f7d040SSatish Balay```{rubric} DM/DA:
11095f7d040SSatish Balay```
11195f7d040SSatish Balay
112e6aa7a3bSBarry Smith-  Change the final argument of `DMShellSetDestroyContext()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it
113e6aa7a3bSBarry Smith
11495f7d040SSatish Balay```{rubric} DMSwarm:
11595f7d040SSatish Balay```
11695f7d040SSatish Balay
11795f7d040SSatish Balay```{rubric} DMPlex:
11895f7d040SSatish Balay```
11995f7d040SSatish Balay
12044a422c4SJames Wright- Add `DMPlexVecGetClosureAtDepth()`
12171f1c950SStefano Zampini- Add an extra communicator argument to `DMPlexFilter()` to allow extracting local meshes
12244a422c4SJames Wright
12395f7d040SSatish Balay```{rubric} FE/FV:
12495f7d040SSatish Balay```
12595f7d040SSatish Balay
12695f7d040SSatish Balay```{rubric} DMNetwork:
12795f7d040SSatish Balay```
12895f7d040SSatish Balay
12995f7d040SSatish Balay```{rubric} DMStag:
13095f7d040SSatish Balay```
13195f7d040SSatish Balay
13295f7d040SSatish Balay```{rubric} DT:
13395f7d040SSatish Balay```
13495f7d040SSatish Balay
13595f7d040SSatish Balay```{rubric} Fortran:
13695f7d040SSatish Balay```
137