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- Add typing stubs for the Python extension module `petsc4py.PETSc`. 21 22```{rubric} Sys: 23``` 24 25- Add `PetscCallHYPRE()` to check HYPRE error codes and print error messages on failure 26 27 28```{rubric} Event Logging: 29``` 30 31- Add two approaches for GPU energy monitoring: `-log_view_gpu_energy` and `-log_view_gpu_energy_meter` 32- Add API `PetscLogGpuEnergy()`, `PetscLogGpuEnergyMeter()`, `PetscLogGpuEnergyMeterBegin()` and `PetscLogGpuEnergyMeterEnd()` for GPU energy monitoring 33 34```{rubric} PetscViewer: 35``` 36 37- Change the final argument of `PetscViewerGLVisSetFields()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it 38 39```{rubric} PetscDraw: 40``` 41 42```{rubric} AO: 43``` 44 45```{rubric} IS: 46``` 47 48```{rubric} VecScatter / PetscSF: 49``` 50 51```{rubric} PF: 52``` 53 54```{rubric} Vec: 55``` 56 57```{rubric} PetscSection: 58``` 59 60```{rubric} PetscPartitioner: 61``` 62 63```{rubric} Mat: 64``` 65 66- Change the `destroy()` function argument of `MatShellSetMatProductOperation()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it 67- Remove `MatMissingDiagonal()`. Developers should use `MatGetDiagonalMarkers_SeqXXX()` when the functionality is needed 68- 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 69 70```{rubric} MatCoarsen: 71``` 72 73```{rubric} PC: 74``` 75 76- 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 77- Add support for MUMPS out-of-core facility with the option `-mat_mumps_ooc_tmpdir <dir>` and new functions `MatMumpsSetOocTmpDir()`, `MatMumpsGetOocTmpDir()` 78 79```{rubric} KSP: 80``` 81 82- Remove `KSPHPDDMPrecision` in favor of `PetscPrecision` 83 84```{rubric} SNES: 85``` 86 87- Change the `destroy()` function argument of `SNESSetConvergenceTest()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it 88- Add `SNESSetObjectiveDomainError()` 89- Change `SNES_DIVERGED_FNORM_NAN` to `SNES_DIVERGED_FUNCTION_NANORINF` 90- Add `SNES_DIVERGED_OBJECTIVE_NANORINF` 91- Add `SNES_DIVERGED_OBJECTIVE_DOMAIN` 92- Add developer functions `SNESCheckFunctionDomainError()`, `SNESLineSearchCheckFunctionDomainError()`, `SNESCheckObjectiveDomainError()`, `SNESLineSearchCheckObjectiveDomainError()`, `SNESCheckJacobianDomainError()`, and `SNESLineSearchCheckJacobianDomainError()` 93 94```{rubric} SNESLineSearch: 95``` 96 97```{rubric} TS: 98``` 99 100- Add `TSPseudoComputeFunction()` to get nonlinear residual while avoiding recalculation if possible 101- Remove unused `TSPseudoVerifyTimeStepDefault()` 102- Remove `TSPseudoComputeTimeStep()` and `TSPseudoVerifyTimeStep()` 103- Change the `destroy()` function argument of `TSTrajectorySetTransform()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it 104- Correct option `-ts_max_reject` to `-ts_max_step_rejections` 105- Correct option `-ts_dt` to `-ts_time_step` 106 107```{rubric} TAO: 108``` 109 110```{rubric} PetscRegressor: 111``` 112 113```{rubric} DM/DA: 114``` 115 116- Change the final argument of `DMShellSetDestroyContext()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it 117 118```{rubric} DMSwarm: 119``` 120 121```{rubric} DMPlex: 122``` 123 124- Add `DMPlexVecGetClosureAtDepth()` 125- Add an extra communicator argument to `DMPlexFilter()` to allow extracting local meshes 126- Add `DMPlexGetLETKFLocalizationMatrix` to compute localization weight matrix for LETKF 127 128```{rubric} FE/FV: 129``` 130 131```{rubric} DMNetwork: 132``` 133 134```{rubric} DMStag: 135``` 136 137```{rubric} DT: 138``` 139 140```{rubric} Fortran: 141``` 142 143- Replace `./configure` option `--with-mpi-f90module-visibility` with `--with-mpi-ftn-module=<mpi or mpi_f08>` 144- Add `PETSC_INT_KIND` and `PETSC_MPIINT_KIND` 145- 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 146 147