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