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