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- Change $PETSC_DIR/lib/petsc/bin/petscfreesharedmemory to $PETSC_DIR/lib/petsc/bin/petscfreesharedmemory.sh 14 15```{rubric} Configure/Build: 16``` 17 18- Make `SYCL` a `devicePackage`, i.e., builds `--with-sycl` now have `PETSC_HAVE_DEVICE` defined 19- Add the option `--with-devicelanguage` to compile `PetscDevice` code using either a C or C++ compiler 20- Add `Caliper`, an instrumentation and performance profiling library that can be used to profile `Hypre`. 21- Add typing stubs for the Python extension module `petsc4py.PETSc`. 22 23```{rubric} Sys: 24``` 25 26- Add `PetscCallHYPRE()` to check HYPRE error codes and print error messages on failure 27- Add `PetscBTCountSet()` to count set bits in `PetscBT` 28- Add the option `-hypre_umpire_device_pool_size <n>` to set the Umpire device memory pool size (in MiB), which is used by HYPRE and 4 Gib by default 29 30 31```{rubric} Event Logging: 32``` 33 34- Add two approaches for GPU energy monitoring: `-log_view_gpu_energy` and `-log_view_gpu_energy_meter` 35- Add API `PetscLogGpuEnergy()`, `PetscLogGpuEnergyMeter()`, `PetscLogGpuEnergyMeterBegin()` and `PetscLogGpuEnergyMeterEnd()` for GPU energy monitoring 36 37```{rubric} PetscViewer: 38``` 39 40- Change the final argument of `PetscViewerGLVisSetFields()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it 41 42```{rubric} PetscDraw: 43``` 44 45```{rubric} AO: 46``` 47 48```{rubric} IS: 49``` 50 51```{rubric} VecScatter / PetscSF: 52``` 53 54```{rubric} PF: 55``` 56 57```{rubric} Vec: 58``` 59 60```{rubric} PetscSection: 61``` 62 63- Add `PetscSectionMigrateData()`, akin to `DMPlexDistributeData()` 64 65```{rubric} PetscPartitioner: 66``` 67 68```{rubric} Mat: 69``` 70 71- Change the `destroy()` function argument of `MatShellSetMatProductOperation()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it 72- Remove `MatMissingDiagonal()`. Developers should use `MatGetDiagonalMarkers_SeqXXX()` when the functionality is needed 73- 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 74- Deprecate `-matmatmult_Bbn` in favor of `-matproduct_batch_size` 75 76```{rubric} MatCoarsen: 77``` 78 79```{rubric} PC: 80``` 81 82- 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 83- Add support for MUMPS out-of-core facility with the option `-mat_mumps_ooc_tmpdir <dir>` and new functions `MatMumpsSetOocTmpDir()`, `MatMumpsGetOocTmpDir()` 84 85```{rubric} KSP: 86``` 87 88- Remove `KSPHPDDMPrecision` in favor of `PetscPrecision` 89 90```{rubric} SNES: 91``` 92 93- Change the `destroy()` function argument of `SNESSetConvergenceTest()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it 94- Add `SNESSetObjectiveDomainError()` 95- Change `SNES_DIVERGED_FNORM_NAN` to `SNES_DIVERGED_FUNCTION_NANORINF` 96- Add `SNES_DIVERGED_OBJECTIVE_NANORINF` 97- Add `SNES_DIVERGED_OBJECTIVE_DOMAIN` 98- Add developer functions `SNESCheckFunctionDomainError()`, `SNESLineSearchCheckFunctionDomainError()`, `SNESCheckObjectiveDomainError()`, `SNESLineSearchCheckObjectiveDomainError()`, `SNESCheckJacobianDomainError()`, and `SNESLineSearchCheckJacobianDomainError()` 99 100```{rubric} SNESLineSearch: 101``` 102 103```{rubric} TS: 104``` 105 106- Add `TSPseudoComputeFunction()` to get nonlinear residual while avoiding recalculation if possible 107- Remove unused `TSPseudoVerifyTimeStepDefault()` 108- Remove `TSPseudoComputeTimeStep()` and `TSPseudoVerifyTimeStep()` 109- Change the `destroy()` function argument of `TSTrajectorySetTransform()` to type `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it 110- Correct option `-ts_max_reject` to `-ts_max_step_rejections` 111- Correct option `-ts_dt` to `-ts_time_step` 112 113```{rubric} TAO: 114``` 115 116```{rubric} PetscRegressor: 117``` 118 119```{rubric} DM/DA: 120``` 121 122- Change the final argument of `DMShellSetDestroyContext()` to `PetscCtxDestroyFn *`. This means the destroy function must dereference the argument before operating on it 123- Add `DMLabelGetValueISGlobal()` to get globally consistent `IS` of values in a `DMLabel` 124 125```{rubric} DMSwarm: 126``` 127 128```{rubric} DMPlex: 129``` 130 131- Add `DMPlexVecGetClosureAtDepth()` 132- Add an extra communicator argument to `DMPlexFilter()` to allow extracting local meshes 133- Add `DMPlexGetLETKFLocalizationMatrix` to compute localization weight matrix for LETKF 134- Change `verticesAdjSaved` parameter in `DMPlexCreateFromCell*Parallel*()` functions to be allocated by function rather than by user 135 136```{rubric} FE/FV: 137``` 138 139```{rubric} DMNetwork: 140``` 141 142```{rubric} DMStag: 143``` 144 145```{rubric} DT: 146``` 147 148```{rubric} Fortran: 149``` 150 151- Replace `./configure` option `--with-mpi-f90module-visibility` with `--with-mpi-ftn-module=<mpi or mpi_f08>` 152- Add `PETSC_INT_KIND` and `PETSC_MPIINT_KIND` 153- 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 154- Fortran interface definitions are now automatically generated for all functions that take context variable arguments, represented in the C source code with a type of `PetscCtx`, allowing the use of any Fortran derived type (or PETSc object) as the context 155- For all PETSc functions `XXXGetYYY()` that return a context variable as an argument, represented in the C source code with an argument type of `PetscCtxRt`, a macro is generated used with `Interface_XXXGetYYY(AppCtx)` which tells the Fortran compiler that a pointer to that derived type `type(AppCtx)` is returned from the Fortran version of `XXXGetYYY()`. See src/snes/tutorials/ex5f90.F90` 156 157