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- Add `PETSCPYTHONPATH` to the generated `$PETSC_DIR/$PETSC_ARCH/lib/petsc/conf/petscvariables` file so it is available to users through the makefile system 13- Add `PETSCPYTHONPATH` to the generated `$PETSC_DIR/$PETSC_ARCH/lib/pkgconfig/PETSc.pc` file so it is available to users with 14 `PKG_CONFIG_PATH=$PETSC_DIR/$PETSC_ARCH/lib/pkgconfig pkg-config --variable=PETSCPYTHONPATH PETSc.pc` 15- Add `EXTRA_OPTIONS_INITIAL` to the test system, which prepends options 16 17```{rubric} Configure/Build: 18``` 19 20- Change `make sphinxhtml` in the `doc` directory to be `make docs` 21- Change `make docs` to put all its artifacts in `${PETSC_ARCH}-doc` instead of `doc` 22- Add support for `--download-xxx`, `--with-xxx`, and `-with-xxx-dir` for Python packages that install with pip. See `packages.py` 23- Change `make alletags` to `make etags` 24- Deactivate Fortran bindings of SuperLU_DIST and ExodusII by default, but they can still be built with the configure options `--with-superlu_dist-fortran-bindings` and `--with-exodusii-fortran-bindings`, respectively 25- Add `--with-python-exec-from-env=python` to allow providing the Python to be used by mpi4py and petsc4py without hard-wiring the full path at ./configure time 26 27```{rubric} Sys: 28``` 29 30- Add `PetscOptionsBool3()` 31- Add `PETSC_E` 32- Deprecate `PetscSSEIsEnabled()` 33- Add `PetscBTCopy()` 34- Change `PetscBool` to be a C bool. It now has a size of one byte, when previously it had a size of four bytes 35- Deprecate `MPIU_BOOL` in favor of `MPI_C_BOOL`. This is now possible since `PetscBool` is now a C bool 36- Add `PetscStackView()` to the public API 37- Change the default file pointer used in `PetscStackView()` if `NULL` is used to `PETSC_STDERR` 38- Add `-petsc_viewer_stdout_format formatname` to allow initializing the format of `PETSC_VIEWER_STDOUT_()` 39 40```{rubric} Event Logging: 41``` 42 43```{rubric} PetscViewer: 44``` 45 46- Add `PetscViewerHDF5SetCompress()` and `PetscViewerHDF5GetCompress()` 47 48```{rubric} PetscDraw: 49``` 50 51- Add `PetscDrawLGGetData()` 52 53```{rubric} AO: 54``` 55 56```{rubric} IS: 57``` 58 59```{rubric} VecScatter / PetscSF: 60``` 61 62- Change `VecSetOperation()` and `VecGetOperation()` so that their final argument must be casted with `PetscErrorCodeFn *` and `PetscErrorCodeFn **` 63 64```{rubric} PF: 65``` 66 67```{rubric} Vec: 68``` 69 70```{rubric} PetscSection: 71``` 72 73- Add `PetscSectionArrayView()` 74 75```{rubric} PetscPartitioner: 76``` 77 78```{rubric} Mat: 79``` 80 81- Add `MatConstantDiagonalGetConstant()` 82- Add `MatNullSpaceRemoveFn` type definition 83- Add `MatMFFDFn`, `MatMFFDiFn`, `MatMFFDiBaseFn`, and `MatMFFDCheckhFn` type definitions 84- Add `MatFDColoringFn` type definition 85- Add support for `-mat_mumps_icntl_15 1` with the companion function `MatMumpsSetBlk()` 86- Change `MatSetOperation()` and `MatGetOperation()` so that their final argument must be casted with `PetscErrorCodeFn *` and `PetscErrorCodeFn **` 87- Change `MatShellSetOperation()` and `MatShellGetOperation()` so that their final argument must be casted with `PetscErrorCodeFn *` and `PetscErrorCodeFn **` 88 89```{rubric} MatCoarsen: 90``` 91 92```{rubric} PC: 93``` 94 95- Add `PCMatApplyTranspose()` and `PCShellSetMatApplyTranspose()` 96- Remove `PC_ApplyMultiple` 97- Add `PCShellPSolveFn` 98- Add `PCModifySubMatricesFn` 99 100```{rubric} KSP: 101``` 102 103- Add `MatLMVMGetLastUpdate()` 104- Add `MatLMVMMultAlgorithm`, `MatLMVMSetMultAlgorithm()`, and `MatLMVMGetMultAlgorithm()` 105- Add `MatLMVMSymBroydenGetPhi()` and `MatLMVMSymBroydenSetPhi()` 106- Add `MatLMVMSymBadBroydenGetPsi()` and `MatLMVMSymBadBroydenSetPsi()` 107- Deprecate `KSP_CONVERGED_RTOL_NORMAL` in favor of `KSP_CONVERGED_RTOL_NORMAL_EQUATIONS` and `KSP_CONVERGED_ATOL_NORMAL` in favor of `KSP_CONVERGED_ATOL_NORMAL_EQUATIONS` 108- Add `KSPFlexibleSetModifyPC()` to provide a common API for setting the modification function for all flexible `KSP` methods 109- Add `KSPFlexibleModifyPCFn` function prototype 110- Change the function signature of the `destroy()` argument to `KSPSetConvergenceTest()` to `PetscCtxDestroyFn*`. If you provide custom destroy 111 functions to `KSPSetConvergenceTest()` you must change them to expect a `void **` argument and immediately dereference the input 112- Add `KSPPSolveFn` 113- Change `KSPMonitorResidualDraw()` to `KSPMonitorResidualView()` 114- Change `KSPMonitorTrueResidualDraw()` to `KSPMonitorTrueResidualView()` 115 116```{rubric} SNES: 117``` 118 119- Change `SNESTestJacobian()` to report the norms 120- Add `SNESNormSchedule` support to `SNESKSPONLY` 121 122```{rubric} SNESLineSearch: 123``` 124 125- Rename option `snes_linesearch_maxstep` to `snes_linesearch_maxlambda` to better coincide with its purpose in the various `SNESLineSearch`es 126- Rename `SNESLineSearchL2` to `SNESLineSearchSecant` (and hence its option entry `snes_linesearch_type` form `l2` to `secant`) to better represent the underlying approach 127 128```{rubric} TS: 129``` 130 131- Add `TSSetRunSteps()` and `-ts_run_steps` for better control of restarted jobs 132- Add `-ts_monitor_solution_skip_initial` to skip first call to the solution monitor 133- Add `-ts_monitor_wall_clock_time` to display the elapsed wall-clock time for every step 134- Change `TSDiscGradIsGonzalez()`, `TSDiscGradUseGonzalez()` to `TSDiscGradSetType()`,`TSDiscGradGetType()` 135 136```{rubric} TAO: 137``` 138 139- Add `TaoBRGNSetRegularizationType()`, `TaoBRGNGetRegularizationType()` 140- Add `TaoGetInequalityConstraintsRoutine()`, `TaoGetEqualityConstraintsRoutine()`, `TaoGetJacobianInequalityRoutine()` and `TaoGetJacobianEqualityRoutine()` 141 142```{rubric} PetscRegressor: 143``` 144 145- Add new component to support regression and classification machine learning tasks: [](ch_regressor) 146- Add `PetscRegressor` type `PETSCREGRESSORLINEAR` for solving linear regression problems with optional regularization 147 148```{rubric} DM/DA: 149``` 150 151- Add `DMHasBound()`, `DM_BC_LOWER_BOUND` and `DM_BC_LOWER_BOUND` 152- Add `DMSetCellCoordinateField()` 153- Add ``localized`` argument to `DMSetCoordinateDisc()` and `DMCreateAffineCoordinates_Internal()` 154- Add `DMCreateGradientMatrix()` 155 156```{rubric} DMSwarm: 157``` 158 159- Add `DMSwarmProjectFields()` and `DMSwarmProjectGradientFields()` 160 161```{rubric} DMPlex: 162``` 163 164- Add `DMPlexGetTransform()`, `DMPlexSetTransform()`, `DMPlexGetSaveTransform()`, and `DMPlexSetSaveTransform()` 165- Add `DMPlexGetCoordinateMap()` and `DMPlexSetCoordinateMap()` 166- Add `DMPlexTransformCohesiveExtrudeGetUnsplit()` 167- Add `DMFieldCreateDefaultFaceQuadrature()` 168- Rename `DMPlexComputeResidual_Internal()` to `DMPlexComputeResidualForKey()` 169- Rename `DMPlexComputeJacobian_Internal()` to `DMPlexComputeJacobianByKey()` 170- Rename `DMPlexComputeJacobian_Action_Internal()` to `DMPlexComputeJacobianActionByKey()` 171- Rename `DMPlexComputeResidual_Hybrid_Internal()` to `DMPlexComputeResidualHybridByKey()` 172- Rename `DMPlexComputeJacobian_Hybrid_Internal()` to `DMPlexComputeJacobianHybridByKey()` 173- Add `DMPlexInsertBounds()` 174- Change argument order for `DMPlexComputeBdResidualSingle()` and `DMPlexComputeBdJacobianSingle()` to match domain functions 175- Add `DMPlexComputeBdResidualSingleByKey()` and `DMPlexComputeBdJacobianSingleByLabel()` 176- Add ``localized`` argument to `DMPlexCreateCoordinateSpace()` 177- Remove ``coordFunc`` argument from `DMPlexCreateCoordinateSpace()` 178- Change `DMPlexExtrude()` to take a label argument 179- Rename `DMPlexVecGetOrientedClosure_Internal()` to `DMPlexVecGetOrientedClosure()` 180- Correctly handle `Mat` preallocation for isoperiodic boundary conditions 181 182```{rubric} FE/FV: 183``` 184 185- Add `PetscFEExpandFaceQuadrature()` 186- Add `PetscFECreateBrokenElement()` 187- Change `PetscFEIntegrateJacobian()` signature to allow rectangular operators 188 189```{rubric} DMNetwork: 190``` 191 192```{rubric} DMStag: 193``` 194 195```{rubric} DT: 196``` 197 198- Deprecate `PetscSimplePointFunc` in favor of `PetscSimplePointFn *` 199- Deprecate `PetscPointFunc` in favor of `PetscPointFn *` 200- Deprecate `PetscPointJac` in favor of `PetscPointJacFn *` 201- Deprecate `PetscBdPointFunc` in favor of `PetscBdPointFn *` 202- Deprecate `PetscBdPointJac` in favor of `PetscBdPointJacFn *` 203- Deprecate `PetscRiemannFunc` in favor of `PetscRiemannFn *` 204- Deprecate `PetscProbFunc` in favor of `PetscProbFn *` 205- Add `PetscDTCreateQuadratureByCell()` 206 207```{rubric} Fortran: 208``` 209 210- Add `PetscObjectNullify()` 211- Require Fortran compiler to have `.true.=b00000001` and `.false.=b00000000` for `logical(C_BOOL)`. Thus require the compiler flags `-fpscomp logicals` for Intel and `-Munixlogical` for NVIDIA compilers 212- Change `PetscBool` to be `logical(C_BOOL)` (equivalent to a `logical(kind=1)`). It now has a size of one byte, previously it was a `logical(kind=4)` and had a size of four bytes 213- Remove the `./configure` option `-with-fortran-type-initialize=0`. Hence, it is now not possible to include PETSc objects in common blocks 214