xref: /petsc/doc/changes/dev.md (revision 8aa39e1bf17a5ea28fa0458095c26b0a3b4f2478)
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
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
23```{rubric} Sys:
24```
25
26- Add `PETSC_E`
27
28- Deprecate `PetscSSEIsEnabled()`
29- Add `PetscBTCopy()`
30
31```{rubric} Event Logging:
32```
33
34```{rubric} PetscViewer:
35```
36
37- Add `PetscViewerHDF5SetCompress()` and `PetscViewerHDF5GetCompress()`
38
39```{rubric} PetscDraw:
40```
41
42- Add `PetscDrawLGGetData()`
43
44```{rubric} AO:
45```
46
47```{rubric} IS:
48```
49
50```{rubric} VecScatter / PetscSF:
51```
52
53```{rubric} PF:
54```
55
56```{rubric} Vec:
57```
58
59```{rubric} PetscSection:
60```
61
62```{rubric} PetscPartitioner:
63```
64
65```{rubric} Mat:
66```
67
68- Add `MatConstantDiagonalGetConstant()`
69- Add `MatNullSpaceRemoveFn` type definition
70- Add `MatMFFDFn`, `MatMFFDiFn`, `MatMFFDiBaseFn`, and `MatMFFDCheckhFn` type definitions
71- Add `MatFDColoringFn` type definition
72
73```{rubric} MatCoarsen:
74```
75
76```{rubric} PC:
77```
78
79- Add `PCMatApplyTranspose()`
80- Remove `PC_ApplyMultiple`
81- Add `PCShellPSolveFn`
82- Add `PCModifySubMatricesFn`
83
84```{rubric} KSP:
85```
86
87- Add `MatLMVMGetLastUpdate()`
88- Add `MatLMVMMultAlgorithm`, `MatLMVMSetMultAlgorithm()`, and `MatLMVMGetMultAlgorithm()`
89- Add `MatLMVMSymBroydenGetPhi()` and `MatLMVMSymBroydenSetPhi()`
90- Add `MatLMVMSymBadBroydenGetPsi()` and `MatLMVMSymBadBroydenSetPsi()`
91- 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`
92- Add `KSPFlexibleSetModifyPC()` to provide a common API for setting the modification function for all flexible `KSP` methods
93- Add `KSPFlexibleModifyPCFn` function prototype
94- Change the function signature of the `destroy()` argument to `KSPSetConvergenceTest()` to `PetscCtxDestroyFn*`. If you provide custom destroy
95  functions to `KSPSetConvergenceTest()` you must change them to expect a `void **` argument and immediately dereference the input
96- Add `KSPPSolveFn`
97
98```{rubric} SNES:
99```
100
101- Change `SNESTestJacobian()` to report the norms
102
103```{rubric} SNESLineSearch:
104```
105
106```{rubric} TS:
107```
108
109- Add `TSSetRunSteps()` and `-ts_run_steps` for better control of restarted jobs
110- Add `-ts_monitor_solution_skip_initial` to skip first call to the solution monitor
111
112```{rubric} TAO:
113```
114
115- Add ``TaoBRGNSetRegularizationType()``, ``TaoBRGNGetRegularizationType()``
116
117```{rubric} PetscRegressor:
118```
119
120- Add new component to support regression and classification machine learning tasks: [](ch_regressor)
121- Add `PetscRegressor` type `PETSCREGRESSORLINEAR` for solving linear regression problems with optional regularization
122
123```{rubric} DM/DA:
124```
125
126- Add `DMHasBound()`, `DM_BC_LOWER_BOUND` and `DM_BC_LOWER_BOUND`
127- Add `DMSetCellCoordinateField()`
128- Add ``localized`` argument to `DMSetCoordinateDisc()` and `DMCreateAffineCoordinates_Internal()`
129
130
131```{rubric} DMSwarm:
132```
133
134```{rubric} DMPlex:
135```
136
137- Add `DMPlexGetTransform()`, `DMPlexSetTransform()`, `DMPlexGetSaveTransform()`, and `DMPlexSetSaveTransform()`
138- Add `DMPlexGetCoordinateMap()` and `DMPlexSetCoordinateMap()`
139- Add `DMPlexTransformCohesiveExtrudeGetUnsplit()`
140- Add `DMFieldCreateDefaultFaceQuadrature()`
141- Rename `DMPlexComputeResidual_Internal()` to `DMPlexComputeResidualForKey()`
142- Rename `DMPlexComputeJacobian_Internal()` to `DMPlexComputeJacobianByKey()`
143- Rename `DMPlexComputeJacobian_Action_Internal()` to `DMPlexComputeJacobianActionByKey()`
144- Rename `DMPlexComputeResidual_Hybrid_Internal()` to `DMPlexComputeResidualHybridByKey()`
145- Rename `DMPlexComputeJacobian_Hybrid_Internal()` to `DMPlexComputeJacobianHybridByKey()`
146- Add `DMPlexInsertBounds()`
147- Change argument order for `DMPlexComputeBdResidualSingle()` and `DMPlexComputeBdJacobianSingle()` to match domain functions
148- Add `DMPlexComputeBdResidualSingleByKey()` and `DMPlexComputeBdJacobianSingleByLabel()`
149- Add ``localized`` argument to `DMPlexCreateCoordinateSpace()`
150- Remove ``coordFunc`` argument from `DMPlexCreateCoordinateSpace()`
151
152```{rubric} FE/FV:
153```
154
155- Add `PetscFEExpandFaceQuadrature()`
156- Add `PetscFECreateBrokenElement()`
157
158```{rubric} DMNetwork:
159```
160
161```{rubric} DMStag:
162```
163
164```{rubric} DT:
165```
166
167- Deprecate `PetscSimplePointFunc` in favor of `PetscSimplePointFn *`
168- Deprecate `PetscPointFunc` in favor of `PetscPointFn *`
169- Deprecate `PetscPointJac` in favor of `PetscPointJacFn *`
170- Deprecate `PetscBdPointFunc` in favor of `PetscBdPointFn *`
171- Deprecate `PetscBdPointJac` in favor of `PetscBdPointJacFn *`
172- Deprecate `PetscRiemannFunc` in favor of `PetscRiemannFn *`
173- Deprecate `PetscProbFunc` in favor of `PetscProbFn *`
174
175```{rubric} Fortran:
176```
177
178- Add `PetscObjectNullify()`
179