Commits

Jed Brown committed bcf0630

KSPSetDM docs: fix KSPSetDMActive args, add cross-references

Comments (0)

Files changed (2)

src/ksp/ksp/interface/iterativ.c

 -  dm - the dm
 
    Notes: If this is used then the KSP will attempt to use the DM to create the matrix and use the routine
-          set with DMKSPSetComputeOperators(). Use KSPSetDMActive(dm,PETSC_FALSE) to instead use the matrix
+          set with DMKSPSetComputeOperators(). Use KSPSetDMActive(ksp,PETSC_FALSE) to instead use the matrix
           you've provided with KSPSetOperators().
 
    Level: intermediate
 
-
-.seealso: KSPGetDM(), KSPSetDMActive(), DMKSPSetComputeOperators()
+.seealso: KSPGetDM(), KSPSetDMActive(), KSPSetComputeOperators(), KSPSetComputeRHS(), KSPSetComputeInitialGuess(), DMKSPSetComputeOperators(), DMKSPSetComputeRHS(), DMKSPSetComputeInitialGuess()
 @*/
 PetscErrorCode  KSPSetDM(KSP ksp,DM dm)
 {
 +  ksp - the preconditioner context
 -  flg - use the DM
 
-   Level: intermediate
-
    Notes:
-   By default KSPSetDM() sets the DM as active, call KSPSetDMActive(dm,PETSC_FALSE); after KSPSetDM(dm) to not have the KSP object use the DM to generate the matrices
+   By default KSPSetDM() sets the DM as active, call KSPSetDMActive(ksp,PETSC_FALSE); after KSPSetDM(ksp,dm) to not have the KSP object use the DM to generate the matrices.
+
+   Level: intermediate
 
-.seealso: KSPGetDM(), KSPSetDM(), SNESSetDM()
+.seealso: KSPGetDM(), KSPSetDM(), SNESSetDM(), KSPSetComputeOperators(), KSPSetComputeRHS(), KSPSetComputeInitialGuess()
 @*/
 PetscErrorCode  KSPSetDMActive(KSP ksp,PetscBool flg)
 {
    Level: intermediate
 
 
-.seealso: KSPSetDM(), KSPGetDM()
+.seealso: KSPSetDM(), KSPSetDMActive()
 @*/
 PetscErrorCode  KSPGetDM(KSP ksp,DM *dm)
 {

src/ksp/ksp/interface/itfunc.c

 
    Level: beginner
 
-.seealso: KSPSetOperators()
+.seealso: KSPSetOperators(), DMKSPSetComputeOperators()
 @*/
 PetscErrorCode KSPSetComputeOperators(KSP ksp,PetscErrorCode (*func)(KSP,Mat,Mat,MatStructure*,void*),void *ctx)
 {
 
    Level: beginner
 
-.seealso: KSPSolve()
+.seealso: KSPSolve(), DMKSPSetComputeRHS()
 @*/
 PetscErrorCode KSPSetComputeRHS(KSP ksp,PetscErrorCode (*func)(KSP,Vec,void*),void *ctx)
 {
 
    Level: beginner
 
-.seealso: KSPSolve()
+.seealso: KSPSolve(), DMKSPSetComputeInitialGuess()
 @*/
 PetscErrorCode KSPSetComputeInitialGuess(KSP ksp,PetscErrorCode (*func)(KSP,Vec,void*),void *ctx)
 {