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