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