Changes: 3.24 — PETSc 3.25.0 documentation

Skip to main content
`Ctrl`+`K`

# Changes: 3.24

General:

- Add `PETSCPYTHONPATH` to the generated `$PETSC_DIR/$PETSC_ARCH/lib/petsc/conf/petscvariables` file so it is available to users through the makefile system

- Add `PETSCPYTHONPATH` to the generated `$PETSC_DIR/$PETSC_ARCH/lib/pkgconfig/PETSc.pc` file so it is available to users with `PKG_CONFIG_PATH=$PETSC_DIR/$PETSC_ARCH/lib/pkgconfig pkg-config --variable=PETSCPYTHONPATH PETSc.pc`

- Add `EXTRA_OPTIONS_INITIAL` to the test system, which prepends options

Configure/Build:

- Change `make sphinxhtml` in the `doc` directory to be `make docs`

- Change `make docs` to put all its artifacts in `${PETSC_ARCH}-doc` instead of `doc`

- Add support for `--download-xxx`, `--with-xxx`, and `-with-xxx-dir` for Python packages that install with pip. See `packages.py`

- Change `make alletags` to `make etags`

- 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

- Add `--with-python-exec-from-env=python` to allow providing the Python to be used by mpi4py and petsc4py without hard-wiring the full path at ./configure time

Sys:

- Add `PetscOptionsBool3()`

- Add `PETSC_E`

- Deprecate `PetscSSEIsEnabled()`

- Add `PetscBTCopy()`

- Change `PetscBool` to be a C bool. It now has a size of one byte, when previously it had a size of four bytes

- Deprecate `MPIU_BOOL` in favor of `MPI_C_BOOL`. This is now possible since `PetscBool` is now a C bool

- Add `PetscStackView()` to the public API

- Change the default file pointer used in `PetscStackView()` if `NULL` is used to `PETSC_STDERR`

- Add `-petsc_viewer_stdout_format formatname` to allow initializing the format of `PETSC_VIEWER_STDOUT_()`

Event Logging:

PetscViewer:

- Add `PetscViewerHDF5SetCompress()` and `PetscViewerHDF5GetCompress()`

PetscDraw:

- Add `PetscDrawLGGetData()`

AO:

IS:

VecScatter / PetscSF:

- Change `VecSetOperation()` and `VecGetOperation()` so that their final argument must be casted with `PetscErrorCodeFn *` and `PetscErrorCodeFn **`

PF:

Vec:

PetscSection:

- Add `PetscSectionArrayView()`

PetscPartitioner:

- Add `PETSCPARTITIONERMULTISTAGE` for improved load balance, edge cut, and performances of large scale unstructured mesh partitioning.

Mat:

- Add `MatConstantDiagonalGetConstant()`

- Add `MatNullSpaceRemoveFn` type definition

- Add `MatMFFDFn`, `MatMFFDiFn`, `MatMFFDiBaseFn`, and `MatMFFDCheckhFn` type definitions

- Add `MatFDColoringFn` type definition

- Add support for `-mat_mumps_icntl_15 1` with the companion function `MatMumpsSetBlk()`

- Change `MatSetOperation()` and `MatGetOperation()` so that their final argument must be casted with `PetscErrorCodeFn *` and `PetscErrorCodeFn **`

- Change `MatShellSetOperation()` and `MatShellGetOperation()` so that their final argument must be casted with `PetscErrorCodeFn *` and `PetscErrorCodeFn **`

MatCoarsen:

PC:

- Add `PCMatApplyTranspose()` and `PCShellSetMatApplyTranspose()`

- Remove `PC_ApplyMultiple`

- Add `PCShellPSolveFn`

- Add `PCModifySubMatricesFn`

- Remove `PCSetPreSolve()` and `PCSetPostSolve()`. See `PCSetPostSetUp()`

KSP:

- Add `MatLMVMGetLastUpdate()`

- Add `MatLMVMMultAlgorithm`, `MatLMVMSetMultAlgorithm()`, and `MatLMVMGetMultAlgorithm()`

- Add `MatLMVMSymBroydenGetPhi()` and `MatLMVMSymBroydenSetPhi()`

- Add `MatLMVMSymBadBroydenGetPsi()` and `MatLMVMSymBadBroydenSetPsi()`

- 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`

- Add `KSPFlexibleSetModifyPC()` to provide a common API for setting the modification function for all flexible `KSP` methods

- Add `KSPFlexibleModifyPCFn` function prototype

- Change the function signature of the `destroy()` argument to `KSPSetConvergenceTest()` to `PetscCtxDestroyFn*`. If you provide custom destroy functions to `KSPSetConvergenceTest()` you must change them to expect a `void **` argument and immediately dereference the input

- Add `KSPPSolveFn`

- Change `KSPMonitorResidualDraw()` to `KSPMonitorResidualView()`

- Change `KSPMonitorTrueResidualDraw()` to `KSPMonitorTrueResidualView()`

SNES:

- Change `SNESTestJacobian()` to report the norms

- Add `SNESNormSchedule` support to `SNESKSPONLY`

SNESLineSearch:

- Rename option `snes_linesearch_maxstep` to `snes_linesearch_maxlambda` to better coincide with its purpose in the various `SNESLineSearch`es

- Rename `SNESLineSearchL2` to `SNESLineSearchSecant` (and hence its option entry `snes_linesearch_type` form `l2` to `secant`) to better represent the underlying approach

TS:

- Add `TSSetRunSteps()` and `-ts_run_steps` for better control of restarted jobs

- Add `-ts_monitor_solution_skip_initial` to skip first call to the solution monitor

- Add `-ts_monitor_wall_clock_time` to display the elapsed wall-clock time for every step

- Change `TSDiscGradIsGonzalez()`, `TSDiscGradUseGonzalez()` to `TSDiscGradSetType()`,`TSDiscGradGetType()`

TAO:

- Add `TaoBRGNSetRegularizationType()`, `TaoBRGNGetRegularizationType()`

- Add `TaoGetInequalityConstraintsRoutine()`, `TaoGetEqualityConstraintsRoutine()`, `TaoGetJacobianInequalityRoutine()` and `TaoGetJacobianEqualityRoutine()`

PetscRegressor:

- Add new component to support regression and classification machine learning tasks: PetscRegressor: Regression Solvers

- Add `PetscRegressor` type `PETSCREGRESSORLINEAR` for solving linear regression problems with optional regularization

DM/DA:

- Add `DMHasBound()`, `DM_BC_LOWER_BOUND` and `DM_BC_LOWER_BOUND`

- Add `DMSetCellCoordinateField()`

- Add `localized` argument to `DMSetCoordinateDisc()` and `DMCreateAffineCoordinates_Internal()`

- Add `DMCreateGradientMatrix()`

DMSwarm:

- Add `DMSwarmProjectFields()` and `DMSwarmProjectGradientFields()`

DMPlex:

- Add `DMPlexGetTransform()`, `DMPlexSetTransform()`, `DMPlexGetSaveTransform()`, and `DMPlexSetSaveTransform()`

- Add `DMPlexGetCoordinateMap()` and `DMPlexSetCoordinateMap()`

- Add `DMPlexTransformCohesiveExtrudeGetUnsplit()`

- Add `DMFieldCreateDefaultFaceQuadrature()`

- Rename `DMPlexComputeResidual_Internal()` to `DMPlexComputeResidualForKey()`

- Rename `DMPlexComputeJacobian_Internal()` to `DMPlexComputeJacobianByKey()`

- Rename `DMPlexComputeJacobian_Action_Internal()` to `DMPlexComputeJacobianActionByKey()`

- Rename `DMPlexComputeResidual_Hybrid_Internal()` to `DMPlexComputeResidualHybridByKey()`

- Rename `DMPlexComputeJacobian_Hybrid_Internal()` to `DMPlexComputeJacobianHybridByKey()`

- Add `DMPlexInsertBounds()`

- Change argument order for `DMPlexComputeBdResidualSingle()` and `DMPlexComputeBdJacobianSingle()` to match domain functions

- Add `DMPlexComputeBdResidualSingleByKey()` and `DMPlexComputeBdJacobianSingleByLabel()`

- Add `localized` argument to `DMPlexCreateCoordinateSpace()`

- Remove `coordFunc` argument from `DMPlexCreateCoordinateSpace()`

- Change `DMPlexExtrude()` to take a label argument

- Rename `DMPlexVecGetOrientedClosure_Internal()` to `DMPlexVecGetOrientedClosure()`

- Correctly handle `Mat` preallocation for isoperiodic boundary conditions

FE/FV:

- Add `PetscFEExpandFaceQuadrature()`

- Add `PetscFECreateBrokenElement()`

- Change `PetscFEIntegrateJacobian()` signature to allow rectangular operators

DMNetwork:

DMStag:

DT:

- Deprecate `PetscSimplePointFunc` in favor of `PetscSimplePointFn *`

- Deprecate `PetscPointFunc` in favor of `PetscPointFn *`

- Deprecate `PetscPointJac` in favor of `PetscPointJacFn *`

- Deprecate `PetscBdPointFunc` in favor of `PetscBdPointFn *`

- Deprecate `PetscBdPointJac` in favor of `PetscBdPointJacFn *`

- Deprecate `PetscRiemannFunc` in favor of `PetscRiemannFn *`

- Deprecate `PetscProbFunc` in favor of `PetscProbFn *`

- Add `PetscDTCreateQuadratureByCell()`

Fortran:

- Add `PetscObjectNullify()`

- 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

- 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

- Remove the `./configure` option `-with-fortran-type-initialize=0`. Hence, it is now not possible to include PETSc objects in common blocks