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