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