xref: /petsc/doc/changes/dev.md (revision 7f01973001a8395880558ae3e5797dbd90504937)
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- Deprecate `PetscSSEIsEnabled()`
27
28```{rubric} Event Logging:
29```
30
31```{rubric} PetscViewer:
32```
33
34- Add `PetscViewerHDF5SetCompress()` and `PetscViewerHDF5GetCompress()`
35
36```{rubric} PetscDraw:
37```
38
39```{rubric} AO:
40```
41
42```{rubric} IS:
43```
44
45```{rubric} VecScatter / PetscSF:
46```
47
48```{rubric} PF:
49```
50
51```{rubric} Vec:
52```
53
54```{rubric} PetscSection:
55```
56
57```{rubric} PetscPartitioner:
58```
59
60```{rubric} Mat:
61```
62
63- Add `MatConstantDiagonalGetConstant()`
64- Add `MatNullSpaceRemoveFn` type definition
65- Add `MatMFFDFn`, `MatMFFDiFn`, `MatMFFDiBaseFn`, and `MatMFFDCheckhFn` type definitions
66- Add `MatFDColoringFn` type definition
67
68```{rubric} MatCoarsen:
69```
70
71```{rubric} PC:
72```
73
74- Add `PCMatApplyTranspose()`
75- Remove `PC_ApplyMultiple`
76
77```{rubric} KSP:
78```
79
80- Add `MatLMVMGetLastUpdate()`
81- Add `MatLMVMMultAlgorithm`, `MatLMVMSetMultAlgorithm()`, and `MatLMVMGetMultAlgorithm()`
82- Add `MatLMVMSymBroydenGetPhi()` and `MatLMVMSymBroydenSetPhi()`
83- Add `MatLMVMSymBadBroydenGetPsi()` and `MatLMVMSymBadBroydenSetPsi()`
84- 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`
85
86```{rubric} SNES:
87```
88
89```{rubric} SNESLineSearch:
90```
91
92```{rubric} TS:
93```
94
95```{rubric} TAO:
96```
97
98- Add ``TaoBRGNSetRegularizationType()``, ``TaoBRGNGetRegularizationType()``
99
100```{rubric} PetscRegressor:
101```
102
103- Add new component to support regression and classification machine learning tasks: [](ch_regressor)
104- Add `PetscRegressor` type `PETSCREGRESSORLINEAR` for solving linear regression problems with optional regularization
105
106```{rubric} DM/DA:
107```
108
109- Add `DMHasBound()`, `DM_BC_LOWER_BOUND` and `DM_BC_LOWER_BOUND`
110
111
112```{rubric} DMSwarm:
113```
114
115```{rubric} DMPlex:
116```
117
118- Add `DMPlexGetTransform()`, `DMPlexSetTransform()`, `DMPlexGetSaveTransform()`, and `DMPlexSetSaveTransform()`
119- Add `DMPlexGetCoordinateMap()` and `DMPlexSetCoordinateMap()`
120- Add `DMPlexTransformCohesiveExtrudeGetUnsplit()`
121- Add `DMFieldCreateDefaultFaceQuadrature()`
122- Rename `DMPlexComputeResidual_Internal()` to `DMPlexComputeResidualForKey()`
123- Rename `DMPlexComputeJacobian_Internal()` to `DMPlexComputeJacobianByKey()`
124- Rename `DMPlexComputeJacobian_Action_Internal()` to `DMPlexComputeJacobianActionByKey()`
125- Rename `DMPlexComputeResidual_Hybrid_Internal()` to `DMPlexComputeResidualHybridByKey()`
126- Rename `DMPlexComputeJacobian_Hybrid_Internal()` to `DMPlexComputeJacobianHybridByKey()`
127- Add `DMPlexInsertBounds()`
128
129```{rubric} FE/FV:
130```
131
132- Add `PetscFEExpandFaceQuadrature()`
133
134```{rubric} DMNetwork:
135```
136
137```{rubric} DMStag:
138```
139
140```{rubric} DT:
141```
142
143- Deprecate `PetscSimplePointFunc` in favor of `PetscSimplePointFn *`
144- Deprecate `PetscPointFunc` in favor of `PetscPointFn *`
145- Deprecate `PetscPointJac` in favor of `PetscPointJacFn *`
146- Deprecate `PetscBdPointFunc` in favor of `PetscBdPointFn *`
147- Deprecate `PetscBdPointJac` in favor of `PetscBdPointJacFn *`
148- Deprecate `PetscRiemannFunc` in favor of `PetscRiemannFn *`
149- Deprecate `PetscProbFunc` in favor of `PetscProbFn *`
150
151```{rubric} Fortran:
152```
153