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