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- Add `PetscSectionMigrateData()`, akin to `DMPlexDistributeData()` 60 61```{rubric} PetscPartitioner: 62``` 63 64```{rubric} Mat: 65``` 66 67- Change the `destroy()` function argument of `MatShellSetMatProductOperation()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it 68- Remove `MatMissingDiagonal()`. Developers should use `MatGetDiagonalMarkers_SeqXXX()` when the functionality is needed 69- 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 70 71```{rubric} MatCoarsen: 72``` 73 74```{rubric} PC: 75``` 76 77- 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 78- Add support for MUMPS out-of-core facility with the option `-mat_mumps_ooc_tmpdir <dir>` and new functions `MatMumpsSetOocTmpDir()`, `MatMumpsGetOocTmpDir()` 79 80```{rubric} KSP: 81``` 82 83- Remove `KSPHPDDMPrecision` in favor of `PetscPrecision` 84 85```{rubric} SNES: 86``` 87 88- Change the `destroy()` function argument of `SNESSetConvergenceTest()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it 89- Add `SNESSetObjectiveDomainError()` 90- Change `SNES_DIVERGED_FNORM_NAN` to `SNES_DIVERGED_FUNCTION_NANORINF` 91- Add `SNES_DIVERGED_OBJECTIVE_NANORINF` 92- Add `SNES_DIVERGED_OBJECTIVE_DOMAIN` 93- Add developer functions `SNESCheckFunctionDomainError()`, `SNESLineSearchCheckFunctionDomainError()`, `SNESCheckObjectiveDomainError()`, `SNESLineSearchCheckObjectiveDomainError()`, `SNESCheckJacobianDomainError()`, and `SNESLineSearchCheckJacobianDomainError()` 94 95```{rubric} SNESLineSearch: 96``` 97 98```{rubric} TS: 99``` 100 101- Add `TSPseudoComputeFunction()` to get nonlinear residual while avoiding recalculation if possible 102- Remove unused `TSPseudoVerifyTimeStepDefault()` 103- Remove `TSPseudoComputeTimeStep()` and `TSPseudoVerifyTimeStep()` 104- Change the `destroy()` function argument of `TSTrajectorySetTransform()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it 105- Correct option `-ts_max_reject` to `-ts_max_step_rejections` 106- Correct option `-ts_dt` to `-ts_time_step` 107 108```{rubric} TAO: 109``` 110 111```{rubric} PetscRegressor: 112``` 113 114```{rubric} DM/DA: 115``` 116 117- Change the final argument of `DMShellSetDestroyContext()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it 118 119```{rubric} DMSwarm: 120``` 121 122```{rubric} DMPlex: 123``` 124 125- Add `DMPlexVecGetClosureAtDepth()` 126- Add an extra communicator argument to `DMPlexFilter()` to allow extracting local meshes 127- Add `DMPlexGetLETKFLocalizationMatrix` to compute localization weight matrix for LETKF 128 129```{rubric} FE/FV: 130``` 131 132```{rubric} DMNetwork: 133``` 134 135```{rubric} DMStag: 136``` 137 138```{rubric} DT: 139``` 140 141```{rubric} Fortran: 142``` 143 144- Replace `./configure` option `--with-mpi-f90module-visibility` with `--with-mpi-ftn-module=<mpi or mpi_f08>` 145- Add `PETSC_INT_KIND` and `PETSC_MPIINT_KIND` 146- 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 147 148