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 and unconstrained minimization 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, SNESProblemType
 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 SNESEQLS          "ls"
 30: #define SNESEQTR          "tr"
 31: #define SNESEQTEST        "test"
 32: #define SNESUMLS          "umls"
 33: #define SNESUMTR          "umtr"
 34: typedef char *SNESType;

 36: /* Logging support */
 37: extern int SNES_COOKIE;
 38: extern int MATSNESMFCTX_COOKIE;
 39: extern int SNES_Solve, SNES_LineSearch, SNES_FunctionEval, SNES_JacobianEval, SNES_MinimizationFunctionEval, SNES_GradientEval;
 40: extern int SNES_HessianEval;

 42: EXTERN int SNESInitializePackage(char *);

 44: /*E
 45:     SNESProblemType - Determines the type of problem this SNES object is to be used to solve

 47:    Level: beginner

 49: .seealso: SNESCreate(), SNESGetProblemType()
 50: E*/
 51: typedef enum {SNES_NONLINEAR_EQUATIONS,SNES_UNCONSTRAINED_MINIMIZATION,SNES_LEAST_SQUARES} SNESProblemType;

 53: EXTERN int SNESCreate(MPI_Comm,SNESProblemType,SNES*);
 54: EXTERN int SNESGetProblemType(SNES,SNESProblemType*);
 55: EXTERN int SNESDestroy(SNES);
 56: EXTERN int SNESSetType(SNES,SNESType);
 57: EXTERN int SNESSetMonitor(SNES,int(*)(SNES,int,PetscReal,void*),void *,int (*)(void *));
 58: EXTERN int SNESClearMonitor(SNES);
 59: EXTERN int SNESSetConvergenceHistory(SNES,PetscReal*,int *,int,PetscTruth);
 60: EXTERN int SNESGetConvergenceHistory(SNES,PetscReal**,int **,int *);
 61: EXTERN int SNESSetUp(SNES,Vec);
 62: EXTERN int SNESSolve(SNES,Vec,int*);

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

 66: EXTERN int SNESSetRhsBC(SNES, int (*)(SNES, Vec, void *));
 67: EXTERN int SNESDefaultRhsBC(SNES, Vec, void *);
 68: EXTERN int SNESSetSolutionBC(SNES, int (*)(SNES, Vec, void *));
 69: EXTERN int SNESDefaultSolutionBC(SNES, Vec, void *);
 70: EXTERN int SNESSetUpdate(SNES, int (*)(SNES, int));
 71: EXTERN int SNESDefaultUpdate(SNES, int);

 73: extern PetscFList SNESList;
 74: EXTERN int SNESRegisterDestroy(void);
 75: EXTERN int SNESRegisterAll(char *);

 77: EXTERN int SNESRegister(char*,char*,char*,int(*)(SNES));
 78: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
 79: #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,0)
 80: #else
 81: #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,d)
 82: #endif

 84: EXTERN int SNESGetSLES(SNES,SLES*);
 85: EXTERN int SNESGetSolution(SNES,Vec*);
 86: EXTERN int SNESGetSolutionUpdate(SNES,Vec*);
 87: EXTERN int SNESGetFunction(SNES,Vec*,void**,int(**)(SNES,Vec,Vec,void*));
 88: EXTERN int SNESView(SNES,PetscViewer);

 90: EXTERN int SNESSetOptionsPrefix(SNES,char*);
 91: EXTERN int SNESAppendOptionsPrefix(SNES,char*);
 92: EXTERN int SNESGetOptionsPrefix(SNES,char**);
 93: EXTERN int SNESSetFromOptions(SNES);

 95: EXTERN int MatCreateSNESMF(SNES,Vec,Mat*);
 96: EXTERN int MatCreateMF(Vec,Mat*);
 97: EXTERN int MatSNESMFSetBase(Mat,Vec);
 98: EXTERN int MatSNESMFComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
 99: EXTERN int MatSNESMFSetFunction(Mat,Vec,int(*)(SNES,Vec,Vec,void*),void*);
100: EXTERN int MatSNESMFSetFunctioni(Mat,int (*)(int,Vec,PetscScalar*,void*));
101: EXTERN int MatSNESMFSetFunctioniBase(Mat,int (*)(Vec,void*));
102: EXTERN int MatSNESMFAddNullSpace(Mat,MatNullSpace);
103: EXTERN int MatSNESMFSetHHistory(Mat,PetscScalar *,int);
104: EXTERN int MatSNESMFResetHHistory(Mat);
105: EXTERN int MatSNESMFSetFunctionError(Mat,PetscReal);
106: EXTERN int MatSNESMFSetPeriod(Mat,int);
107: EXTERN int MatSNESMFGetH(Mat,PetscScalar *);
108: EXTERN int MatSNESMFKSPMonitor(KSP,int,PetscReal,void *);
109: EXTERN int MatSNESMFSetFromOptions(Mat);
110: typedef struct _p_MatSNESMFCtx   *MatSNESMFCtx;

112: #define MATSNESMF_DEFAULT "default"
113: #define MATSNESMF_WP      "wp"
114: typedef char* MatSNESMFType;
115: EXTERN int MatSNESMFSetType(Mat,MatSNESMFType);
116: EXTERN int MatSNESMFRegister(char *,char *,char *,int (*)(MatSNESMFCtx));
117: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
118: #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,0)
119: #else
120: #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,d)
121: #endif
122: EXTERN int MatSNESMFRegisterAll(char *);
123: EXTERN int MatSNESMFRegisterDestroy(void);
124: EXTERN int MatSNESMFDefaultSetUmin(Mat,PetscReal);
125: EXTERN int MatSNESMFWPSetComputeNormA(Mat,PetscTruth);
126: EXTERN int MatSNESMFWPSetComputeNormU(Mat,PetscTruth);

128: EXTERN int MatDAADSetSNES(Mat,SNES);

130: EXTERN int SNESGetType(SNES,SNESType*);
131: EXTERN int SNESDefaultMonitor(SNES,int,PetscReal,void *);
132: EXTERN int SNESRatioMonitor(SNES,int,PetscReal,void *);
133: EXTERN int SNESSetRatioMonitor(SNES);
134: EXTERN int SNESVecViewMonitor(SNES,int,PetscReal,void *);
135: EXTERN int SNESVecViewUpdateMonitor(SNES,int,PetscReal,void *);
136: EXTERN int SNESDefaultSMonitor(SNES,int,PetscReal,void *);
137: EXTERN int SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,int,int);
138: EXTERN int SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,int*,int*);
139: EXTERN int SNESSetTrustRegionTolerance(SNES,PetscReal);
140: EXTERN int SNESGetIterationNumber(SNES,int*);
141: EXTERN int SNESGetFunctionNorm(SNES,PetscScalar*);
142: EXTERN int SNESGetNumberUnsuccessfulSteps(SNES,int*);
143: EXTERN int SNESSetMaximumUnsuccessfulSteps(SNES,int);
144: EXTERN int SNESGetMaximumUnsuccessfulSteps(SNES,int*);
145: EXTERN int SNESGetNumberLinearIterations(SNES,int*);
146: EXTERN int SNES_KSP_SetParametersEW(SNES,int,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
147: EXTERN int SNES_KSP_SetConvergenceTestEW(SNES);

149: /*
150:      Reuse the default KSP monitor routines for SNES
151: */
152: EXTERN int SNESLGMonitorCreate(char*,char*,int,int,int,int,PetscDrawLG*);
153: EXTERN int SNESLGMonitor(SNES,int,PetscReal,void*);
154: EXTERN int SNESLGMonitorDestroy(PetscDrawLG);

156: EXTERN int SNESSetApplicationContext(SNES,void *);
157: EXTERN int SNESGetApplicationContext(SNES,void **);

159: /*E
160:     SNESConvergedReason - reason a SNES method was said to 
161:          have converged or diverged

163:    Level: beginner

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

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

185: EXTERN int SNESSetConvergenceTest(SNES,int (*)(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*);
186: EXTERN int SNESConverged_UM_LS(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
187: EXTERN int SNESConverged_UM_TR(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
188: EXTERN int SNESConverged_EQ_LS(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
189: EXTERN int SNESConverged_EQ_TR(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
190: EXTERN int SNESGetConvergedReason(SNES,SNESConvergedReason*);

192: EXTERN int SNESDAFormFunction(SNES,Vec,Vec,void*);
193: EXTERN int SNESDAComputeJacobianWithAdic(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
194: EXTERN int SNESDAComputeJacobianWithAdifor(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
195: EXTERN int SNESDAComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);

197: /* --------- Solving systems of nonlinear equations --------------- */
198: EXTERN int SNESSetFunction(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void *);
199: EXTERN int SNESComputeFunction(SNES,Vec,Vec);
200: EXTERN int SNESSetJacobian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *);
201: EXTERN int SNESGetJacobian(SNES,Mat*,Mat*,void **,int(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*));
202: EXTERN int SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
203: EXTERN int SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
204: EXTERN int SNESSetLineSearch(SNES,int(*)(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*),void*);
205: EXTERN int SNESNoLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*);
206: EXTERN int SNESNoLineSearchNoNorms(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*);
207: EXTERN int SNESCubicLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*);
208: EXTERN int SNESQuadraticLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*);
209: EXTERN int SNESSetLineSearchCheck(SNES,int(*)(SNES,void*,Vec,PetscTruth*),void*);
210: EXTERN int SNESSetLineSearchParams(SNES,PetscReal,PetscReal,PetscReal);
211: EXTERN int SNESGetLineSearchParams(SNES,PetscReal*,PetscReal*,PetscReal*);

213: /* --------- Unconstrained minimization routines --------------------------------*/
214: EXTERN int SNESSetHessian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *);
215: EXTERN int SNESGetHessian(SNES,Mat*,Mat*,void **);
216: EXTERN int SNESDefaultComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
217: EXTERN int SNESDefaultComputeHessianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
218: EXTERN int SNESSetGradient(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void*);
219: EXTERN int SNESGetGradient(SNES,Vec*,void**);
220: EXTERN int SNESGetGradientNorm(SNES,PetscScalar*);
221: EXTERN int SNESComputeGradient(SNES,Vec,Vec);
222: EXTERN int SNESSetMinimizationFunction(SNES,int(*)(SNES,Vec,PetscReal*,void*),void*);
223: EXTERN int SNESComputeMinimizationFunction(SNES,Vec,PetscReal*);
224: EXTERN int SNESGetMinimizationFunction(SNES,PetscReal*,void**);
225: EXTERN int SNESSetMinimizationFunctionTolerance(SNES,PetscReal);
226: EXTERN int SNESLineSearchSetDampingParameter(SNES,PetscScalar*);


229: /* Should these 2 routines be private? */
230: EXTERN int SNESComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*);
231: EXTERN int SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*);

233: #endif