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