Actual source code: petscsnes.h

  1: /* $Id: petscsnes.h,v 1.111 2001/08/06 21:17:05 bsmith Exp $ */
  2: /*
  3:     User interface for the nonlinear solvers package.
  4: */
 7:  #include petscsles.h

  9: /*S
 10:      SNES - Abstract PETSc object that manages all nonlinear solves

 12:    Level: beginner

 14:   Concepts: nonlinear solvers

 16: .seealso:  SNESCreate(), SNESSetType(), SNESType, TS, SLES, KSP, PC
 17: S*/
 18: typedef struct _p_SNES* SNES;

 20: /*E
 21:     SNESType - String with the name of a PETSc SNES method or the creation function
 22:        with an optional dynamic library name, for example
 23:        http://www.mcs.anl.gov/petsc/lib.a:mysnescreate()

 25:    Level: beginner

 27: .seealso: SNESSetType(), SNES
 28: E*/
 29: #define SNESLS          "ls"
 30: #define SNESTR          "tr"
 31: #define SNESTEST        "test"
 32: typedef char *SNESType;

 34: /* Logging support */
 35: extern int SNES_COOKIE;
 36: extern int SNES_Solve, SNES_LineSearch, SNES_FunctionEval, SNES_JacobianEval;


 39: EXTERN int SNESInitializePackage(char *);

 41: EXTERN int SNESCreate(MPI_Comm,SNES*);
 42: EXTERN int SNESDestroy(SNES);
 43: EXTERN int SNESSetType(SNES,SNESType);
 44: EXTERN int SNESSetMonitor(SNES,int(*)(SNES,int,PetscReal,void*),void *,int (*)(void *));
 45: EXTERN int SNESClearMonitor(SNES);
 46: EXTERN int SNESSetConvergenceHistory(SNES,PetscReal*,int *,int,PetscTruth);
 47: EXTERN int SNESGetConvergenceHistory(SNES,PetscReal**,int **,int *);
 48: EXTERN int SNESSetUp(SNES,Vec);
 49: EXTERN int SNESSolve(SNES,Vec,int*);

 51: EXTERN int SNESAddOptionsChecker(int (*)(SNES));

 53: EXTERN int SNESSetRhsBC(SNES, int (*)(SNES, Vec, void *));
 54: EXTERN int SNESDefaultRhsBC(SNES, Vec, void *);
 55: EXTERN int SNESSetSolutionBC(SNES, int (*)(SNES, Vec, void *));
 56: EXTERN int SNESDefaultSolutionBC(SNES, Vec, void *);
 57: EXTERN int SNESSetUpdate(SNES, int (*)(SNES, int));
 58: EXTERN int SNESDefaultUpdate(SNES, int);

 60: extern PetscFList SNESList;
 61: EXTERN int SNESRegisterDestroy(void);
 62: EXTERN int SNESRegisterAll(char *);

 64: EXTERN int SNESRegister(char*,char*,char*,int(*)(SNES));
 65: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
 66: #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,0)
 67: #else
 68: #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,d)
 69: #endif

 71: EXTERN int SNESGetSLES(SNES,SLES*);
 72: EXTERN int SNESGetSolution(SNES,Vec*);
 73: EXTERN int SNESGetSolutionUpdate(SNES,Vec*);
 74: EXTERN int SNESGetFunction(SNES,Vec*,void**,int(**)(SNES,Vec,Vec,void*));
 75: EXTERN int SNESView(SNES,PetscViewer);

 77: EXTERN int SNESSetOptionsPrefix(SNES,char*);
 78: EXTERN int SNESAppendOptionsPrefix(SNES,char*);
 79: EXTERN int SNESGetOptionsPrefix(SNES,char**);
 80: EXTERN int SNESSetFromOptions(SNES);

 82: EXTERN int MatCreateSNESMF(SNES,Vec,Mat*);
 83: EXTERN int MatCreateMF(Vec,Mat*);
 84: EXTERN int MatSNESMFSetBase(Mat,Vec);
 85: EXTERN int MatSNESMFComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
 86: EXTERN int MatSNESMFSetFunction(Mat,Vec,int(*)(SNES,Vec,Vec,void*),void*);
 87: EXTERN int MatSNESMFSetFunctioni(Mat,int (*)(int,Vec,PetscScalar*,void*));
 88: EXTERN int MatSNESMFSetFunctioniBase(Mat,int (*)(Vec,void*));
 89: EXTERN int MatSNESMFAddNullSpace(Mat,MatNullSpace);
 90: EXTERN int MatSNESMFSetHHistory(Mat,PetscScalar *,int);
 91: EXTERN int MatSNESMFResetHHistory(Mat);
 92: EXTERN int MatSNESMFSetFunctionError(Mat,PetscReal);
 93: EXTERN int MatSNESMFSetPeriod(Mat,int);
 94: EXTERN int MatSNESMFGetH(Mat,PetscScalar *);
 95: EXTERN int MatSNESMFKSPMonitor(KSP,int,PetscReal,void *);
 96: EXTERN int MatSNESMFSetFromOptions(Mat);
 97: EXTERN int MatSNESMFCheckPositivity(Vec,Vec,PetscScalar*,void*);
 98: EXTERN int MatSNESMFSetCheckh(Mat,int (*)(Vec,Vec,PetscScalar*,void*),void*);

100: typedef struct _p_MatSNESMFCtx   *MatSNESMFCtx;

102: #define MATSNESMF_DEFAULT "default"
103: #define MATSNESMF_WP      "wp"
104: typedef char* MatSNESMFType;
105: EXTERN int MatSNESMFSetType(Mat,MatSNESMFType);
106: EXTERN int MatSNESMFRegister(char *,char *,char *,int (*)(MatSNESMFCtx));
107: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
108: #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,0)
109: #else
110: #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,d)
111: #endif
112: EXTERN int MatSNESMFRegisterAll(char *);
113: EXTERN int MatSNESMFRegisterDestroy(void);
114: EXTERN int MatSNESMFDefaultSetUmin(Mat,PetscReal);
115: EXTERN int MatSNESMFWPSetComputeNormA(Mat,PetscTruth);
116: EXTERN int MatSNESMFWPSetComputeNormU(Mat,PetscTruth);

118: EXTERN int MatDAADSetSNES(Mat,SNES);

120: EXTERN int SNESGetType(SNES,SNESType*);
121: EXTERN int SNESDefaultMonitor(SNES,int,PetscReal,void *);
122: EXTERN int SNESRatioMonitor(SNES,int,PetscReal,void *);
123: EXTERN int SNESSetRatioMonitor(SNES);
124: EXTERN int SNESVecViewMonitor(SNES,int,PetscReal,void *);
125: EXTERN int SNESVecViewResidualMonitor(SNES,int,PetscReal,void *);
126: EXTERN int SNESVecViewUpdateMonitor(SNES,int,PetscReal,void *);
127: EXTERN int SNESDefaultSMonitor(SNES,int,PetscReal,void *);
128: EXTERN int SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,int,int);
129: EXTERN int SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,int*,int*);
130: EXTERN int SNESSetTrustRegionTolerance(SNES,PetscReal);
131: EXTERN int SNESGetIterationNumber(SNES,int*);
132: EXTERN int SNESGetFunctionNorm(SNES,PetscScalar*);
133: EXTERN int SNESGetNumberUnsuccessfulSteps(SNES,int*);
134: EXTERN int SNESSetMaximumUnsuccessfulSteps(SNES,int);
135: EXTERN int SNESGetMaximumUnsuccessfulSteps(SNES,int*);
136: EXTERN int SNESGetNumberLinearIterations(SNES,int*);
137: EXTERN int SNES_KSP_SetParametersEW(SNES,int,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
138: EXTERN int SNES_KSP_SetConvergenceTestEW(SNES);

140: /*
141:      Reuse the default KSP monitor routines for SNES
142: */
143: EXTERN int SNESLGMonitorCreate(char*,char*,int,int,int,int,PetscDrawLG*);
144: EXTERN int SNESLGMonitor(SNES,int,PetscReal,void*);
145: EXTERN int SNESLGMonitorDestroy(PetscDrawLG);

147: EXTERN int SNESSetApplicationContext(SNES,void *);
148: EXTERN int SNESGetApplicationContext(SNES,void **);

150: /*E
151:     SNESConvergedReason - reason a SNES method was said to 
152:          have converged or diverged

154:    Level: beginner

156:    Notes: this must match finclude/petscsnes.h 

158: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest()
159: E*/
160: typedef enum {/* converged */
161:               SNES_CONVERGED_FNORM_ABS         =  2, /* F < F_minabs */
162:               SNES_CONVERGED_FNORM_RELATIVE    =  3, /* F < F_mintol*F_initial */
163:               SNES_CONVERGED_PNORM_RELATIVE    =  4, /* step size small */
164:               SNES_CONVERGED_GNORM_ABS         =  5, /* grad F < grad F_min */
165:               SNES_CONVERGED_TR_REDUCTION      =  6,
166:               SNES_CONVERGED_TR_DELTA          =  7,
167:               /* diverged */
168:               SNES_DIVERGED_FUNCTION_COUNT     = -2,
169:               SNES_DIVERGED_FNORM_NAN          = -4,
170:               SNES_DIVERGED_MAX_IT             = -5,
171:               SNES_DIVERGED_LS_FAILURE         = -6,
172:               SNES_DIVERGED_TR_REDUCTION       = -7,
173:               SNES_DIVERGED_LOCAL_MIN          = -8,  /* || J^T b || is small, implies converged to local minimum of F() */
174:               SNES_CONVERGED_ITERATING         =  0} SNESConvergedReason;

176: EXTERN int SNESSetConvergenceTest(SNES,int (*)(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*);
177: EXTERN int SNESConverged_LS(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
178: EXTERN int SNESConverged_TR(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
179: EXTERN int SNESGetConvergedReason(SNES,SNESConvergedReason*);

181: EXTERN int SNESDAFormFunction(SNES,Vec,Vec,void*);
182: EXTERN int SNESDAComputeJacobianWithAdic(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
183: EXTERN int SNESDAComputeJacobianWithAdifor(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
184: EXTERN int SNESDAComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);

186: /* --------- Solving systems of nonlinear equations --------------- */
187: EXTERN int SNESSetFunction(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void *);
188: EXTERN int SNESComputeFunction(SNES,Vec,Vec);
189: EXTERN int SNESSetJacobian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *);
190: EXTERN int SNESGetJacobian(SNES,Mat*,Mat*,void **,int(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*));
191: EXTERN int SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
192: EXTERN int SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
193: EXTERN int SNESSetLineSearch(SNES,int(*)(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*),void*);
194: EXTERN int SNESNoLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*);
195: EXTERN int SNESNoLineSearchNoNorms(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*);
196: EXTERN int SNESCubicLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*);
197: EXTERN int SNESQuadraticLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*);
198: EXTERN int SNESSetLineSearchCheck(SNES,int(*)(SNES,void*,Vec,PetscTruth*),void*);
199: EXTERN int SNESSetLineSearchParams(SNES,PetscReal,PetscReal,PetscReal);
200: EXTERN int SNESGetLineSearchParams(SNES,PetscReal*,PetscReal*,PetscReal*);

202: EXTERN int SNESTestLocalMin(SNES snes);

204: /* Should this routine be private? */
205: EXTERN int SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*);

207: #endif