Actual source code: petscsnes.h
petsc-3.10.5 2019-03-28
Report Typos and Errors

      1: /*
      2:     User interface for the nonlinear solvers package.
      3: */
      6:  #include <petscksp.h>
      7:  #include <petscdmtypes.h>
      8:  #include <petscfvtypes.h>
      9:  #include <petscdmdatypes.h>

     11: /*S
     12:      SNES - Abstract PETSc object that manages all nonlinear solves

     14:    Level: beginner

     16:   Concepts: nonlinear solvers

     18: .seealso:  SNESCreate(), SNESSetType(), SNESType, TS, KSP, KSP, PC, SNESDestroy()
     19: S*/
     20: typedef struct _p_SNES* SNES;

     22: /*J
     23:     SNESType - String with the name of a PETSc SNES method.

     25:    Level: beginner

     27: .seealso: SNESSetType(), SNES, SNESCreate(), SNESDestroy(), SNESSetFromOptions()
     28: J*/
     29: typedef const char* SNESType;
     30: #define SNESNEWTONLS     "newtonls"
     31: #define SNESNEWTONTR     "newtontr"
     32: #define SNESPYTHON       "python"
     33: #define SNESNRICHARDSON  "nrichardson"
     34: #define SNESKSPONLY      "ksponly"
     35: #define SNESVINEWTONRSLS "vinewtonrsls"
     36: #define SNESVINEWTONSSLS "vinewtonssls"
     37: #define SNESNGMRES       "ngmres"
     38: #define SNESQN           "qn"
     39: #define SNESSHELL        "shell"
     40: #define SNESNGS          "ngs"
     41: #define SNESNCG          "ncg"
     42: #define SNESFAS          "fas"
     43: #define SNESMS           "ms"
     44: #define SNESNASM         "nasm"
     45: #define SNESANDERSON     "anderson"
     46: #define SNESASPIN        "aspin"
     47: #define SNESCOMPOSITE    "composite"

     49: /* Logging support */
     50: PETSC_EXTERN PetscClassId SNES_CLASSID;
     51: PETSC_EXTERN PetscClassId DMSNES_CLASSID;

     53: PETSC_EXTERN PetscErrorCode SNESInitializePackage(void);

     55: PETSC_EXTERN PetscErrorCode SNESCreate(MPI_Comm,SNES*);
     56: PETSC_EXTERN PetscErrorCode SNESReset(SNES);
     57: PETSC_EXTERN PetscErrorCode SNESDestroy(SNES*);
     58: PETSC_EXTERN PetscErrorCode SNESSetType(SNES,SNESType);
     59: PETSC_EXTERN PetscErrorCode SNESMonitor(SNES,PetscInt,PetscReal);
     60: PETSC_EXTERN PetscErrorCode SNESMonitorSet(SNES,PetscErrorCode(*)(SNES,PetscInt,PetscReal,void*),void *,PetscErrorCode (*)(void**));
     61: PETSC_EXTERN PetscErrorCode SNESMonitorSetFromOptions(SNES,const char[],const char[],const char [],PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscViewerAndFormat*),PetscErrorCode (*)(SNES,PetscViewerAndFormat*));
     62: PETSC_EXTERN PetscErrorCode SNESMonitorCancel(SNES);
     63: PETSC_EXTERN PetscErrorCode SNESMonitorSAWs(SNES,PetscInt,PetscReal,void*);
     64: PETSC_EXTERN PetscErrorCode SNESMonitorSAWsCreate(SNES,void**);
     65: PETSC_EXTERN PetscErrorCode SNESMonitorSAWsDestroy(void**);
     66: PETSC_EXTERN PetscErrorCode SNESSetConvergenceHistory(SNES,PetscReal[],PetscInt[],PetscInt,PetscBool );
     67: PETSC_EXTERN PetscErrorCode SNESGetConvergenceHistory(SNES,PetscReal*[],PetscInt *[],PetscInt *);
     68: PETSC_EXTERN PetscErrorCode SNESSetUp(SNES);
     69: PETSC_EXTERN PetscErrorCode SNESSolve(SNES,Vec,Vec);
     70: PETSC_EXTERN PetscErrorCode SNESSetErrorIfNotConverged(SNES,PetscBool );
     71: PETSC_EXTERN PetscErrorCode SNESGetErrorIfNotConverged(SNES,PetscBool  *);

     73: PETSC_EXTERN PetscErrorCode SNESSetWorkVecs(SNES,PetscInt);

     75: PETSC_EXTERN PetscErrorCode SNESAddOptionsChecker(PetscErrorCode (*)(SNES));

     77: PETSC_EXTERN PetscErrorCode SNESSetUpdate(SNES, PetscErrorCode (*)(SNES, PetscInt));

     80: PETSC_EXTERN PetscErrorCode SNESRegister(const char[],PetscErrorCode (*)(SNES));

     82: PETSC_EXTERN PetscErrorCode SNESGetKSP(SNES,KSP*);
     83: PETSC_EXTERN PetscErrorCode SNESSetKSP(SNES,KSP);
     84: PETSC_EXTERN PetscErrorCode SNESSetSolution(SNES,Vec);
     85: PETSC_EXTERN PetscErrorCode SNESGetSolution(SNES,Vec*);
     86: PETSC_EXTERN PetscErrorCode SNESGetSolutionUpdate(SNES,Vec*);
     87: PETSC_EXTERN PetscErrorCode SNESGetRhs(SNES,Vec*);
     88: PETSC_EXTERN PetscErrorCode SNESView(SNES,PetscViewer);
     89: PETSC_EXTERN PetscErrorCode SNESLoad(SNES,PetscViewer);
     90: PETSC_STATIC_INLINE PetscErrorCode SNESViewFromOptions(SNES A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
     91: PETSC_EXTERN PetscErrorCode SNESReasonView(SNES,PetscViewer);
     92: PETSC_EXTERN PetscErrorCode SNESReasonViewFromOptions(SNES);

     94: #define SNES_FILE_CLASSID 1211224

     96: PETSC_EXTERN PetscErrorCode SNESSetOptionsPrefix(SNES,const char[]);
     97: PETSC_EXTERN PetscErrorCode SNESAppendOptionsPrefix(SNES,const char[]);
     98: PETSC_EXTERN PetscErrorCode SNESGetOptionsPrefix(SNES,const char*[]);
     99: PETSC_EXTERN PetscErrorCode SNESSetFromOptions(SNES);
    100: PETSC_EXTERN PetscErrorCode SNESResetFromOptions(SNES);

    102: PETSC_EXTERN PetscErrorCode SNESSetUseMatrixFree(SNES,PetscBool,PetscBool);
    103: PETSC_EXTERN PetscErrorCode SNESGetUseMatrixFree(SNES,PetscBool*,PetscBool*);
    104: PETSC_EXTERN PetscErrorCode MatCreateSNESMF(SNES,Mat*);
    105: PETSC_EXTERN PetscErrorCode MatSNESMFGetSNES(Mat,SNES*);
    106: PETSC_EXTERN PetscErrorCode MatSNESMFSetReuseBase(Mat,PetscBool);
    107: PETSC_EXTERN PetscErrorCode MatSNESMFGetReuseBase(Mat,PetscBool*);
    108: PETSC_EXTERN PetscErrorCode MatMFFDComputeJacobian(SNES,Vec,Mat,Mat,void*);

    110: PETSC_EXTERN PetscErrorCode MatDAADSetSNES(Mat,SNES);

    112: PETSC_EXTERN PetscErrorCode SNESGetType(SNES,SNESType*);
    113: PETSC_EXTERN PetscErrorCode SNESMonitorDefault(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
    114: PETSC_EXTERN PetscErrorCode SNESMonitorScaling(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
    115: PETSC_EXTERN PetscErrorCode SNESMonitorRange(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
    116: PETSC_EXTERN PetscErrorCode SNESMonitorRatio(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
    117: PETSC_EXTERN PetscErrorCode SNESMonitorRatioSetUp(SNES,PetscViewerAndFormat*);
    118: PETSC_EXTERN PetscErrorCode SNESMonitorSolution(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
    119: PETSC_EXTERN PetscErrorCode SNESMonitorResidual(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
    120: PETSC_EXTERN PetscErrorCode SNESMonitorSolutionUpdate(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
    121: PETSC_EXTERN PetscErrorCode SNESMonitorDefaultShort(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
    122: PETSC_EXTERN PetscErrorCode SNESMonitorDefaultField(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
    123: PETSC_EXTERN PetscErrorCode SNESMonitorJacUpdateSpectrum(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
    124: PETSC_EXTERN PetscErrorCode SNESMonitorFields(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
    125: PETSC_EXTERN PetscErrorCode KSPMonitorSNES(KSP,PetscInt,PetscReal,void*);
    126: PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNormCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscObject**);
    127: PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNorm(KSP,PetscInt,PetscReal,PetscObject*);
    128: PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNormDestroy(PetscObject**);

    130: PETSC_EXTERN PetscErrorCode SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt);
    131: PETSC_EXTERN PetscErrorCode SNESSetDivergenceTolerance(SNES,PetscReal);
    132: PETSC_EXTERN PetscErrorCode SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*);
    133: PETSC_EXTERN PetscErrorCode SNESGetDivergenceTolerance(SNES,PetscReal*);
    134: PETSC_EXTERN PetscErrorCode SNESSetTrustRegionTolerance(SNES,PetscReal);
    135: PETSC_EXTERN PetscErrorCode SNESGetForceIteration(SNES,PetscBool*);
    136: PETSC_EXTERN PetscErrorCode SNESSetForceIteration(SNES,PetscBool);
    137: PETSC_EXTERN PetscErrorCode SNESGetIterationNumber(SNES,PetscInt*);
    138: PETSC_EXTERN PetscErrorCode SNESSetIterationNumber(SNES,PetscInt);

    140: PETSC_EXTERN PetscErrorCode SNESGetNonlinearStepFailures(SNES,PetscInt*);
    141: PETSC_EXTERN PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES,PetscInt);
    142: PETSC_EXTERN PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES,PetscInt*);
    143: PETSC_EXTERN PetscErrorCode SNESGetNumberFunctionEvals(SNES,PetscInt*);

    145: PETSC_EXTERN PetscErrorCode SNESSetLagPreconditioner(SNES,PetscInt);
    146: PETSC_EXTERN PetscErrorCode SNESGetLagPreconditioner(SNES,PetscInt*);
    147: PETSC_EXTERN PetscErrorCode SNESSetLagJacobian(SNES,PetscInt);
    148: PETSC_EXTERN PetscErrorCode SNESGetLagJacobian(SNES,PetscInt*);
    149: PETSC_EXTERN PetscErrorCode SNESSetLagPreconditionerPersists(SNES,PetscBool);
    150: PETSC_EXTERN PetscErrorCode SNESSetLagJacobianPersists(SNES,PetscBool);
    151: PETSC_EXTERN PetscErrorCode SNESSetGridSequence(SNES,PetscInt);
    152: PETSC_EXTERN PetscErrorCode SNESGetGridSequence(SNES,PetscInt*);

    154: PETSC_EXTERN PetscErrorCode SNESGetLinearSolveIterations(SNES,PetscInt*);
    155: PETSC_EXTERN PetscErrorCode SNESGetLinearSolveFailures(SNES,PetscInt*);
    156: PETSC_EXTERN PetscErrorCode SNESSetMaxLinearSolveFailures(SNES,PetscInt);
    157: PETSC_EXTERN PetscErrorCode SNESGetMaxLinearSolveFailures(SNES,PetscInt*);
    158: PETSC_EXTERN PetscErrorCode SNESSetCountersReset(SNES,PetscBool);

    160: PETSC_EXTERN PetscErrorCode SNESKSPSetUseEW(SNES,PetscBool );
    161: PETSC_EXTERN PetscErrorCode SNESKSPGetUseEW(SNES,PetscBool *);
    162: PETSC_EXTERN PetscErrorCode SNESKSPSetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
    163: PETSC_EXTERN PetscErrorCode SNESKSPGetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*);

    165:  #include <petscdrawtypes.h>
    166: PETSC_EXTERN PetscErrorCode SNESMonitorLGCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDrawLG*);
    167: PETSC_EXTERN PetscErrorCode SNESMonitorLGResidualNorm(SNES,PetscInt,PetscReal,void*);
    168: PETSC_EXTERN PetscErrorCode SNESMonitorLGRange(SNES,PetscInt,PetscReal,void*);

    170: PETSC_EXTERN PetscErrorCode SNESSetApplicationContext(SNES,void *);
    171: PETSC_EXTERN PetscErrorCode SNESGetApplicationContext(SNES,void *);
    172: PETSC_EXTERN PetscErrorCode SNESSetComputeApplicationContext(SNES,PetscErrorCode (*)(SNES,void**),PetscErrorCode (*)(void**));

    174: PETSC_EXTERN PetscErrorCode SNESPythonSetType(SNES,const char[]);

    176: PETSC_EXTERN PetscErrorCode SNESSetFunctionDomainError(SNES);
    177: PETSC_EXTERN PetscErrorCode SNESGetFunctionDomainError(SNES, PetscBool *);

    179: /*E
    180:     SNESConvergedReason - reason a SNES method was said to
    181:          have converged or diverged

    183:    Level: beginner

    185:    The two most common reasons for divergence are
    186: $   1) an incorrectly coded or computed Jacobian or
    187: $   2) failure or lack of convergence in the linear system (in this case we recommend
    188: $      testing with -pc_type lu to eliminate the linear solver as the cause of the problem).

    190:    Diverged Reasons:
    191: .    SNES_DIVERGED_LOCAL_MIN - this can only occur when using the line-search variant of SNES.
    192:        The line search wants to minimize Q(alpha) = 1/2 || F(x + alpha s) ||^2_2  this occurs
    193:        at Q'(alpha) = s^T F'(x+alpha s)^T F(x+alpha s) = 0. If s is the Newton direction - F'(x)^(-1)F(x) then
    194:        you get Q'(alpha) = -F(x)^T F'(x)^(-1)^T F'(x+alpha s)F(x+alpha s); when alpha = 0
    195:        Q'(0) = - ||F(x)||^2_2 which is always NEGATIVE if F'(x) is invertible. This means the Newton
    196:        direction is a descent direction and the line search should succeed if alpha is small enough.

    198:        If F'(x) is NOT invertible AND F'(x)^T F(x) = 0 then Q'(0) = 0 and the Newton direction
    199:        is NOT a descent direction so the line search will fail. All one can do at this point
    200:        is change the initial guess and try again.

    202:        An alternative explanation: Newton's method can be regarded as replacing the function with
    203:        its linear approximation and minimizing the 2-norm of that. That is F(x+s) approx F(x) + F'(x)s
    204:        so we minimize || F(x) + F'(x) s ||^2_2; do this using Least Squares. If F'(x) is invertible then
    205:        s = - F'(x)^(-1)F(x) otherwise F'(x)^T F'(x) s = -F'(x)^T F(x). If F'(x)^T F(x) is NOT zero then there
    206:        exists a nontrival (that is F'(x)s != 0) solution to the equation and this direction is
    207:        s = - [F'(x)^T F'(x)]^(-1) F'(x)^T F(x) so Q'(0) = - F(x)^T F'(x) [F'(x)^T F'(x)]^(-T) F'(x)^T F(x)
    208:        = - (F'(x)^T F(x)) [F'(x)^T F'(x)]^(-T) (F'(x)^T F(x)). Since we are assuming (F'(x)^T F(x)) != 0
    209:        and F'(x)^T F'(x) has no negative eigenvalues Q'(0) < 0 so s is a descent direction and the line
    210:        search should succeed for small enough alpha.

    212:        Note that this RARELY happens in practice. Far more likely the linear system is not being solved
    213:        (well enough?) or the Jacobian is wrong.

    215:    SNES_DIVERGED_MAX_IT means that the solver reached the maximum number of iterations without satisfying any
    216:    convergence criteria. SNES_CONVERGED_ITS means that SNESConvergedSkip() was chosen as the convergence test;
    217:    thus the usual convergence criteria have not been checked and may or may not be satisfied.

    219:    Developer Notes:
    220:     this must match petsc/finclude/petscsnes.h

    222:        The string versions of these are in SNESConvergedReasons, if you change any value here you must
    223:      also adjust that array.

    225:    Each reason has its own manual page.

    227: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest()
    228: E*/
    229: typedef enum {/* converged */
    230:               SNES_CONVERGED_FNORM_ABS         =  2, /* ||F|| < atol */
    231:               SNES_CONVERGED_FNORM_RELATIVE    =  3, /* ||F|| < rtol*||F_initial|| */
    232:               SNES_CONVERGED_SNORM_RELATIVE    =  4, /* Newton computed step size small; || delta x || < stol || x ||*/
    233:               SNES_CONVERGED_ITS               =  5, /* maximum iterations reached */
    234:               SNES_CONVERGED_TR_DELTA          =  7,
    235:               /* diverged */
    236:               SNES_DIVERGED_FUNCTION_DOMAIN     = -1, /* the new x location passed the function is not in the domain of F */
    237:               SNES_DIVERGED_FUNCTION_COUNT      = -2,
    238:               SNES_DIVERGED_LINEAR_SOLVE        = -3, /* the linear solve failed */
    239:               SNES_DIVERGED_FNORM_NAN           = -4,
    240:               SNES_DIVERGED_MAX_IT              = -5,
    241:               SNES_DIVERGED_LINE_SEARCH         = -6, /* the line search failed */
    242:               SNES_DIVERGED_INNER               = -7, /* inner solve failed */
    243:               SNES_DIVERGED_LOCAL_MIN           = -8, /* || J^T b || is small, implies converged to local minimum of F() */
    244:               SNES_DIVERGED_DTOL                = -9, /* || F || > divtol*||F_initial|| */

    246:               SNES_CONVERGED_ITERATING          =  0} SNESConvergedReason;
    247: PETSC_EXTERN const char *const*SNESConvergedReasons;

    249: /*MC
    250:      SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol

    252:    Level: beginner

    254: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()

    256: M*/

    258: /*MC
    259:      SNES_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess

    261:    Level: beginner

    263: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()

    265: M*/

    267: /*MC
    268:      SNES_CONVERGED_SNORM_RELATIVE - The 2-norm of the last step <= stol * 2-norm(x) where x is the current
    269:           solution and stol is the 4th argument to SNESSetTolerances()

    271:      Options Database Keys:
    272:       -snes_stol <stol> - the step tolerance

    274:    Level: beginner

    276: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()

    278: M*/

    280: /*MC
    281:      SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final
    282:          argument to SNESSetTolerances()

    284:    Level: beginner

    286: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()

    288: M*/

    290: /*MC
    291:      SNES_DIVERGED_DTOL - The norm of the function has increased by a factor of divtol set with SNESSetDivergenceTolerance()

    293:    Level: beginner

    295: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances(), SNESSetDivergenceTolerance()

    297: M*/

    299: /*MC
    300:      SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this
    301:       is usually caused by a division of 0 by 0.

    303:    Level: beginner

    305: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()

    307: M*/

    309: /*MC
    310:      SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested

    312:    Level: beginner

    314: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()

    316: M*/

    318: /*MC
    319:      SNES_DIVERGED_LINE_SEARCH - The line search has failed. This only occurs for a SNES solvers that use a line search

    321:    Level: beginner

    323: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances(), SNESLineSearch

    325: M*/

    327: /*MC
    328:      SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero.
    329:         See the manual page for SNESConvergedReason for more details

    331:    Level: beginner

    333: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()

    335: M*/

    337: /*MC
    338:      SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve()

    340:    Level: beginner

    342: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()

    344: M*/

    346: PETSC_EXTERN PetscErrorCode SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
    347: PETSC_EXTERN PetscErrorCode SNESConvergedDefault(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
    348: PETSC_EXTERN PetscErrorCode SNESConvergedSkip(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
    349: PETSC_EXTERN PetscErrorCode SNESGetConvergedReason(SNES,SNESConvergedReason*);
    350: PETSC_EXTERN PetscErrorCode SNESSetConvergedReason(SNES,SNESConvergedReason);

    352: PETSC_DEPRECATED("Use SNESConvergedSkip()") PETSC_STATIC_INLINE void SNESSkipConverged(void) { /* never called */ }
    353: #define SNESSkipConverged (SNESSkipConverged, SNESConvergedSkip)

    355: /* --------- Solving systems of nonlinear equations --------------- */
    356: PETSC_EXTERN PetscErrorCode SNESSetFunction(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*);
    357: PETSC_EXTERN PetscErrorCode SNESGetFunction(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**);
    358: PETSC_EXTERN PetscErrorCode SNESComputeFunction(SNES,Vec,Vec);
    359: PETSC_EXTERN PetscErrorCode SNESSetInitialFunction(SNES,Vec);

    361: PETSC_EXTERN PetscErrorCode SNESSetJacobian(SNES,Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat,Mat,void*),void*);
    362: PETSC_EXTERN PetscErrorCode SNESGetJacobian(SNES,Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat,Mat,void*),void**);
    363: PETSC_EXTERN PetscErrorCode SNESObjectiveComputeFunctionDefaultFD(SNES,Vec,Vec,void*);
    364: PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefault(SNES,Vec,Mat,Mat,void*);
    365: PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefaultColor(SNES,Vec,Mat,Mat,void*);
    366: PETSC_EXTERN PetscErrorCode SNESSetComputeInitialGuess(SNES,PetscErrorCode (*)(SNES,Vec,void*),void*);
    367: PETSC_EXTERN PetscErrorCode SNESSetPicard(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat,Mat,void*),void*);
    368: PETSC_EXTERN PetscErrorCode SNESGetPicard(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat,Mat,void*),void**);
    369: PETSC_EXTERN PetscErrorCode SNESPicardComputeFunction(SNES,Vec,Vec,void *);
    370: PETSC_EXTERN PetscErrorCode SNESPicardComputeJacobian(SNES,Vec,Mat,Mat,void*);

    372: PETSC_EXTERN PetscErrorCode SNESSetObjective(SNES,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*);
    373: PETSC_EXTERN PetscErrorCode SNESGetObjective(SNES,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**);
    374: PETSC_EXTERN PetscErrorCode SNESComputeObjective(SNES,Vec,PetscReal *);

    376: /*E
    377:     SNESNormSchedule - Frequency with which the norm is computed

    379:    Level: advanced

    381:    Support for these is highly dependent on the solver.

    383:    Notes:
    384:    This is primarily used to turn off extra norm and function computation
    385:    when the solvers are composed.

    387: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
    388:           KSPSetConvergenceTest(), KSPSetPCSide()
    389: E*/

    391: typedef enum {SNES_NORM_DEFAULT            = -1,
    392:               SNES_NORM_NONE               =  0,
    393:               SNES_NORM_ALWAYS             =  1,
    394:               SNES_NORM_INITIAL_ONLY       =  2,
    395:               SNES_NORM_FINAL_ONLY         =  3,
    396:               SNES_NORM_INITIAL_FINAL_ONLY =  4} SNESNormSchedule;
    397: PETSC_EXTERN const char *const*const SNESNormSchedules;

    399: /*MC
    400:     SNES_NORM_NONE - Don't compute function and its L2 norm.

    402:    Level: advanced

    404:     Notes:
    405:     This is most useful for stationary solvers with a fixed number of iterations used as smoothers.

    407: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_DEFAULT
    408: M*/

    410: /*MC
    411:     SNES_NORM_ALWAYS - Compute the function and its L2 norm at each iteration.

    413:    Level: advanced

    415:     Notes:
    416:     Most solvers will use this no matter what norm type is passed to them.

    418: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_NONE
    419: M*/

    421: /*MC
    422:     SNES_NORM_INITIAL_ONLY - Compute the function and its L2 at iteration 0, but do not update it.

    424:    Level: advanced

    426:    Notes:
    427:    This method is useful in composed methods, when a true solution might actually be found before SNESSolve() is called.
    428:    This option enables the solve to abort on the zeroth iteration if this is the case.

    430:    For solvers that require the computation of the L2 norm of the function as part of the method, this merely cancels
    431:    the norm computation at the last iteration (if possible).

    433: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_FINAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
    434: M*/

    436: /*MC
    437:     SNES_NORM_FINAL_ONLY - Compute the function and its L2 norm on only the final iteration.

    439:    Level: advanced

    441:    Notes:
    442:    For solvers that require the computation of the L2 norm of the function as part of the method, behaves
    443:    exactly as SNES_NORM_DEFAULT.  This method is useful when the function is gotten after SNESSolve and
    444:    used in subsequent computation for methods that do not need the norm computed during the rest of the
    445:    solution procedure.

    447: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_INITIAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
    448: M*/

    450: /*MC
    451:     SNES_NORM_INITIAL_FINAL_ONLY - Compute the function and its L2 norm on only the initial and final iterations.

    453:    Level: advanced

    455:    Notes:
    456:    This method combines the benefits of SNES_NORM_INITIAL_ONLY and SNES_NORM_FINAL_ONLY.

    458: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_SNES_NORM_INITIAL_ONLY, SNES_NORM_FINAL_ONLY
    459: M*/

    461: PETSC_EXTERN PetscErrorCode SNESSetNormSchedule(SNES,SNESNormSchedule);
    462: PETSC_EXTERN PetscErrorCode SNESGetNormSchedule(SNES,SNESNormSchedule*);
    463: PETSC_EXTERN PetscErrorCode SNESSetFunctionNorm(SNES,PetscReal);
    464: PETSC_EXTERN PetscErrorCode SNESGetFunctionNorm(SNES,PetscReal*);

    466: /*E
    467:     SNESFunctionType - Type of function computed

    469:    Level: advanced

    471:    Support for these is highly dependent on the solver.

    473: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
    474:           KSPSetConvergenceTest(), KSPSetPCSide()
    475: E*/
    476: typedef enum {SNES_FUNCTION_DEFAULT          = -1,
    477:               SNES_FUNCTION_UNPRECONDITIONED =  0,
    478:               SNES_FUNCTION_PRECONDITIONED   =  1} SNESFunctionType;
    479: PETSC_EXTERN const char *const*const SNESFunctionTypes;

    481: PETSC_EXTERN PetscErrorCode SNESSetFunctionType(SNES,SNESFunctionType);
    482: PETSC_EXTERN PetscErrorCode SNESGetFunctionType(SNES,SNESFunctionType*);

    484: PETSC_EXTERN PetscErrorCode SNESSetNGS(SNES,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*);
    485: PETSC_EXTERN PetscErrorCode SNESGetNGS(SNES,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**);
    486: PETSC_EXTERN PetscErrorCode SNESSetUseNGS(SNES,PetscBool);
    487: PETSC_EXTERN PetscErrorCode SNESGetUseNGS(SNES,PetscBool *);
    488: PETSC_EXTERN PetscErrorCode SNESComputeNGS(SNES,Vec,Vec);

    490: PETSC_EXTERN PetscErrorCode SNESNGSSetSweeps(SNES,PetscInt);
    491: PETSC_EXTERN PetscErrorCode SNESNGSGetSweeps(SNES,PetscInt *);
    492: PETSC_EXTERN PetscErrorCode SNESNGSSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt);
    493: PETSC_EXTERN PetscErrorCode SNESNGSGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*);

    495: PETSC_EXTERN PetscErrorCode SNESUpdateCheckJacobian(SNES,PetscInt);

    497: PETSC_EXTERN PetscErrorCode SNESSetAlwaysComputesFinalResidual(SNES,PetscBool);
    498: PETSC_EXTERN PetscErrorCode SNESGetAlwaysComputesFinalResidual(SNES,PetscBool*);

    500: PETSC_EXTERN PetscErrorCode SNESShellGetContext(SNES,void**);
    501: PETSC_EXTERN PetscErrorCode SNESShellSetContext(SNES,void*);
    502: PETSC_EXTERN PetscErrorCode SNESShellSetSolve(SNES,PetscErrorCode (*)(SNES,Vec));

    504: /* --------- Routines specifically for line search methods --------------- */

    507: /*S
    508:      SNESLineSearch - Abstract PETSc object that manages line-search operations

    510:    Level: beginner

    512:   Concepts: nonlinear solvers, line search

    514: .seealso:  SNESLineSearchCreate(), SNESLineSearchSetType(), SNES
    515: S*/
    516: typedef struct _p_LineSearch* SNESLineSearch;

    518: /*J
    519:     SNESLineSearchType - String with the name of a PETSc line search method

    521:    Level: beginner

    523: .seealso: SNESLineSearchSetType(), SNES
    524: J*/
    525: typedef const char* SNESLineSearchType;
    526: #define SNESLINESEARCHBT                 "bt"
    527: #define SNESLINESEARCHNLEQERR            "nleqerr"
    528: #define SNESLINESEARCHBASIC              "basic"
    529: #define SNESLINESEARCHL2                 "l2"
    530: #define SNESLINESEARCHCP                 "cp"
    531: #define SNESLINESEARCHSHELL              "shell"

    533: PETSC_EXTERN PetscFunctionList SNESList;
    534: PETSC_EXTERN PetscClassId      SNESLINESEARCH_CLASSID;
    535: PETSC_EXTERN PetscFunctionList SNESLineSearchList;

    537: #define SNES_LINESEARCH_ORDER_LINEAR    1
    538: #define SNES_LINESEARCH_ORDER_QUADRATIC 2
    539: #define SNES_LINESEARCH_ORDER_CUBIC     3

    541: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVIProjectFunc)(SNES,Vec);
    542: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVINormFunc)(SNES,Vec,Vec,PetscReal *);
    543: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchApplyFunc)(SNESLineSearch);
    544: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchUserFunc)(SNESLineSearch, void *);

    546: PETSC_EXTERN PetscErrorCode SNESLineSearchCreate(MPI_Comm, SNESLineSearch*);
    547: PETSC_EXTERN PetscErrorCode SNESLineSearchReset(SNESLineSearch);
    548: PETSC_EXTERN PetscErrorCode SNESLineSearchView(SNESLineSearch,PetscViewer);
    549: PETSC_EXTERN PetscErrorCode SNESLineSearchDestroy(SNESLineSearch *);
    550: PETSC_EXTERN PetscErrorCode SNESLineSearchSetType(SNESLineSearch, SNESLineSearchType);
    551: PETSC_EXTERN PetscErrorCode SNESLineSearchSetFromOptions(SNESLineSearch);
    552: PETSC_EXTERN PetscErrorCode SNESLineSearchSetFunction(SNESLineSearch,PetscErrorCode (*)(SNES,Vec,Vec));
    553: PETSC_EXTERN PetscErrorCode SNESLineSearchSetUp(SNESLineSearch);
    554: PETSC_EXTERN PetscErrorCode SNESLineSearchApply(SNESLineSearch, Vec, Vec, PetscReal *, Vec);
    555: PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheck(SNESLineSearch,Vec,Vec,PetscBool *);
    556: PETSC_EXTERN PetscErrorCode SNESLineSearchPostCheck(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *);
    557: PETSC_EXTERN PetscErrorCode SNESLineSearchSetWorkVecs(SNESLineSearch, PetscInt);

    559: /* set the functions for precheck and postcheck */

    561: PETSC_EXTERN PetscErrorCode SNESLineSearchSetPreCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void *ctx);
    562: PETSC_EXTERN PetscErrorCode SNESLineSearchSetPostCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void *ctx);

    564: PETSC_EXTERN PetscErrorCode SNESLineSearchGetPreCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void **ctx);
    565: PETSC_EXTERN PetscErrorCode SNESLineSearchGetPostCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void **ctx);

    567: /* set the functions for VI-specific line search operations */

    569: PETSC_EXTERN PetscErrorCode SNESLineSearchSetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc, SNESLineSearchVINormFunc);
    570: PETSC_EXTERN PetscErrorCode SNESLineSearchGetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc*, SNESLineSearchVINormFunc*);

    572: /* pointers to the associated SNES in order to be able to get the function evaluation out */
    573: PETSC_EXTERN PetscErrorCode SNESLineSearchSetSNES(SNESLineSearch,SNES);
    574: PETSC_EXTERN PetscErrorCode SNESLineSearchGetSNES(SNESLineSearch,SNES*);

    576: /* set and get the parameters and vectors */
    577: PETSC_EXTERN PetscErrorCode SNESLineSearchGetTolerances(SNESLineSearch,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscInt*);
    578: PETSC_EXTERN PetscErrorCode SNESLineSearchSetTolerances(SNESLineSearch,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscInt);

    580: PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheckPicard(SNESLineSearch,Vec,Vec,PetscBool*,void*);

    582: PETSC_EXTERN PetscErrorCode SNESLineSearchGetLambda(SNESLineSearch,PetscReal*);
    583: PETSC_EXTERN PetscErrorCode SNESLineSearchSetLambda(SNESLineSearch,PetscReal);

    585: PETSC_EXTERN PetscErrorCode SNESLineSearchGetDamping(SNESLineSearch,PetscReal*);
    586: PETSC_EXTERN PetscErrorCode SNESLineSearchSetDamping(SNESLineSearch,PetscReal);

    588: PETSC_EXTERN PetscErrorCode SNESLineSearchGetOrder(SNESLineSearch,PetscInt *order);
    589: PETSC_EXTERN PetscErrorCode SNESLineSearchSetOrder(SNESLineSearch,PetscInt order);

    591: /*E
    592:     SNESLineSearchReason - if line search has succeeded or failed and why

    594:    Level: intermediate

    596:    Developer Notes:
    597:     this must match petsc/finclude/petscsnes.h

    599:    Developer Note: The string versions of these are in SNESLineSearchReasons, if you change any value here you must
    600:      also adjust that array.

    602: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest()
    603: E*/
    604: typedef enum {SNES_LINESEARCH_SUCCEEDED,
    605:               SNES_LINESEARCH_FAILED_NANORINF,
    606:               SNES_LINESEARCH_FAILED_DOMAIN,
    607:               SNES_LINESEARCH_FAILED_REDUCT,       /* INSUFFICENT REDUCTION */
    608:               SNES_LINESEARCH_FAILED_USER,
    609:               SNES_LINESEARCH_FAILED_FUNCTION} SNESLineSearchReason;

    611: PETSC_EXTERN PetscErrorCode SNESLineSearchGetReason(SNESLineSearch, SNESLineSearchReason*);
    612: PETSC_EXTERN PetscErrorCode SNESLineSearchSetReason(SNESLineSearch, SNESLineSearchReason);

    614: PETSC_EXTERN PetscErrorCode SNESLineSearchGetVecs(SNESLineSearch,Vec*,Vec*,Vec*,Vec*,Vec*);
    615: PETSC_EXTERN PetscErrorCode SNESLineSearchSetVecs(SNESLineSearch,Vec,Vec,Vec,Vec,Vec);

    617: PETSC_EXTERN PetscErrorCode SNESLineSearchGetNorms(SNESLineSearch, PetscReal *, PetscReal *, PetscReal *);
    618: PETSC_EXTERN PetscErrorCode SNESLineSearchSetNorms(SNESLineSearch, PetscReal, PetscReal, PetscReal);
    619: PETSC_EXTERN PetscErrorCode SNESLineSearchComputeNorms(SNESLineSearch);
    620: PETSC_EXTERN PetscErrorCode SNESLineSearchSetComputeNorms(SNESLineSearch, PetscBool);

    622: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitor(SNESLineSearch);
    623: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorSet(SNESLineSearch,PetscErrorCode(*)(SNESLineSearch,void*),void *,PetscErrorCode (*)(void**));
    624: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorSetFromOptions(SNESLineSearch,const char[],const char[],const char[],PetscErrorCode (*)(SNESLineSearch,PetscViewerAndFormat*),PetscErrorCode (*)(SNESLineSearch,PetscViewerAndFormat*));
    625: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorCancel(SNESLineSearch);
    626: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorUpdate(SNESLineSearch,PetscViewerAndFormat*);
    627: PETSC_EXTERN PetscErrorCode SNESLineSearchSetDefaultMonitor(SNESLineSearch,PetscViewer);
    628: PETSC_EXTERN PetscErrorCode SNESLineSearchGetDefaultMonitor(SNESLineSearch,PetscViewer*);
    629: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorSolutionUpdate(SNESLineSearch,PetscViewerAndFormat*);

    631: PETSC_EXTERN PetscErrorCode SNESLineSearchAppendOptionsPrefix(SNESLineSearch, const char prefix[]);
    632: PETSC_EXTERN PetscErrorCode SNESLineSearchGetOptionsPrefix(SNESLineSearch, const char *prefix[]);

    635: /* Shell interface functions */
    636: PETSC_EXTERN PetscErrorCode SNESLineSearchShellSetUserFunc(SNESLineSearch,SNESLineSearchUserFunc,void*);
    637: PETSC_EXTERN PetscErrorCode SNESLineSearchShellGetUserFunc(SNESLineSearch,SNESLineSearchUserFunc*,void**);

    639: /* BT interface functions */
    640: PETSC_EXTERN PetscErrorCode SNESLineSearchBTSetAlpha(SNESLineSearch, PetscReal);
    641: PETSC_EXTERN PetscErrorCode SNESLineSearchBTGetAlpha(SNESLineSearch, PetscReal*);

    643: /*register line search types */
    644: PETSC_EXTERN PetscErrorCode SNESLineSearchRegister(const char[],PetscErrorCode(*)(SNESLineSearch));

    646: /* Routines for VI solver */
    647: PETSC_EXTERN PetscErrorCode SNESVISetVariableBounds(SNES,Vec,Vec);
    648: PETSC_EXTERN PetscErrorCode SNESVISetComputeVariableBounds(SNES, PetscErrorCode (*)(SNES,Vec,Vec));
    649: PETSC_EXTERN PetscErrorCode SNESVIGetInactiveSet(SNES,IS*);
    650: PETSC_EXTERN PetscErrorCode SNESVIGetActiveSetIS(SNES,Vec,Vec,IS*);
    651: PETSC_EXTERN PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES,Vec,Vec,PetscReal*);
    652: PETSC_EXTERN PetscErrorCode SNESVISetRedundancyCheck(SNES,PetscErrorCode(*)(SNES,IS,IS*,void*),void*);

    654: PETSC_EXTERN PetscErrorCode SNESTestLocalMin(SNES);

    656: /* Should this routine be private? */
    657: PETSC_EXTERN PetscErrorCode SNESComputeJacobian(SNES,Vec,Mat,Mat);
    658: PETSC_EXTERN PetscErrorCode SNESTestJacobian(SNES);

    660: PETSC_EXTERN PetscErrorCode SNESSetDM(SNES,DM);
    661: PETSC_EXTERN PetscErrorCode SNESGetDM(SNES,DM*);
    662: PETSC_EXTERN PetscErrorCode SNESSetNPC(SNES,SNES);
    663: PETSC_EXTERN PetscErrorCode SNESGetNPC(SNES,SNES*);
    664: PETSC_EXTERN PetscErrorCode SNESHasNPC(SNES,PetscBool*);
    665: PETSC_EXTERN PetscErrorCode SNESApplyNPC(SNES,Vec,Vec,Vec);
    666: PETSC_EXTERN PetscErrorCode SNESGetNPCFunction(SNES,Vec,PetscReal*);
    667: PETSC_EXTERN PetscErrorCode SNESComputeFunctionDefaultNPC(SNES,Vec,Vec);
    668: PETSC_EXTERN PetscErrorCode SNESSetNPCSide(SNES,PCSide);
    669: PETSC_EXTERN PetscErrorCode SNESGetNPCSide(SNES,PCSide*);
    670: PETSC_EXTERN PetscErrorCode SNESSetLineSearch(SNES,SNESLineSearch);
    671: PETSC_EXTERN PetscErrorCode SNESGetLineSearch(SNES,SNESLineSearch*);
    672: PETSC_EXTERN PetscErrorCode SNESRestrictHookAdd(SNES,PetscErrorCode (*)(SNES,SNES,void*),void*);
    673: PETSC_EXTERN PetscErrorCode SNESRestrictHooksRun(SNES,SNES);

    675: PETSC_DEPRECATED("Use SNESGetLineSearch()") PETSC_STATIC_INLINE PetscErrorCode SNESGetSNESLineSearch(SNES snes,SNESLineSearch *ls) {return SNESGetLineSearch(snes,ls);}
    676: PETSC_DEPRECATED("Use SNESSetLineSearch()") PETSC_STATIC_INLINE PetscErrorCode SNESSetSNESLineSearch(SNES snes,SNESLineSearch ls) {return SNESSetLineSearch(snes,ls);}

    678: PETSC_EXTERN PetscErrorCode SNESSetUpMatrices(SNES);
    679: PETSC_EXTERN PetscErrorCode DMSNESSetFunction(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
    680: PETSC_EXTERN PetscErrorCode DMSNESGetFunction(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
    681: PETSC_EXTERN PetscErrorCode DMSNESSetNGS(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
    682: PETSC_EXTERN PetscErrorCode DMSNESGetNGS(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
    683: PETSC_EXTERN PetscErrorCode DMSNESSetJacobian(DM,PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*);
    684: PETSC_EXTERN PetscErrorCode DMSNESGetJacobian(DM,PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**);
    685: PETSC_EXTERN PetscErrorCode DMSNESSetPicard(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*);
    686: PETSC_EXTERN PetscErrorCode DMSNESGetPicard(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**);
    687: PETSC_EXTERN PetscErrorCode DMSNESSetObjective(DM,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*);
    688: PETSC_EXTERN PetscErrorCode DMSNESGetObjective(DM,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**);
    689: PETSC_EXTERN PetscErrorCode DMCopyDMSNES(DM,DM);

    691: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESFunction)(DMDALocalInfo*,void*,void*,void*);
    692: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESJacobian)(DMDALocalInfo*,void*,Mat,Mat,void*);
    693: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESObjective)(DMDALocalInfo*,void*,PetscReal*,void*);

    695: PETSC_EXTERN PetscErrorCode DMDASNESSetFunctionLocal(DM,InsertMode,DMDASNESFunction,void*);
    696: PETSC_EXTERN PetscErrorCode DMDASNESSetJacobianLocal(DM,DMDASNESJacobian,void*);
    697: PETSC_EXTERN PetscErrorCode DMDASNESSetObjectiveLocal(DM,DMDASNESObjective,void*);
    698: PETSC_EXTERN PetscErrorCode DMDASNESSetPicardLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,void*,void*,void*),PetscErrorCode (*)(DMDALocalInfo*,void*,Mat,Mat,void*),void*);

    700: PETSC_EXTERN PetscErrorCode DMPlexSNESGetGeometryFVM(DM,Vec*,Vec*,PetscReal*);
    701: PETSC_EXTERN PetscErrorCode DMPlexSNESGetGradientDM(DM,PetscFV,DM*);
    702: PETSC_EXTERN PetscErrorCode DMPlexGetCellFields(DM, IS, Vec, Vec, Vec, PetscScalar **, PetscScalar **, PetscScalar **);
    703: PETSC_EXTERN PetscErrorCode DMPlexRestoreCellFields(DM, IS, Vec, Vec, Vec, PetscScalar **, PetscScalar **, PetscScalar **);
    704: PETSC_EXTERN PetscErrorCode DMPlexGetFaceFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, Vec, Vec, PetscInt *, PetscScalar **, PetscScalar **);
    705: PETSC_EXTERN PetscErrorCode DMPlexRestoreFaceFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, Vec, Vec, PetscInt *, PetscScalar **, PetscScalar **);
    706: PETSC_EXTERN PetscErrorCode DMPlexGetFaceGeometry(DM, PetscInt, PetscInt, Vec, Vec, PetscInt *, PetscFVFaceGeom **, PetscReal **);
    707: PETSC_EXTERN PetscErrorCode DMPlexRestoreFaceGeometry(DM, PetscInt, PetscInt, Vec, Vec, PetscInt *, PetscFVFaceGeom **, PetscReal **);

    709: PETSC_EXTERN PetscErrorCode DMSNESSetBoundaryLocal(DM,PetscErrorCode (*)(DM,Vec,void*),void*);
    710: PETSC_EXTERN PetscErrorCode DMSNESSetFunctionLocal(DM,PetscErrorCode (*)(DM,Vec,Vec,void*),void*);
    711: PETSC_EXTERN PetscErrorCode DMSNESSetJacobianLocal(DM,PetscErrorCode (*)(DM,Vec,Mat,Mat,void*),void*);

    713: /* Routines for Multiblock solver */
    714: PETSC_EXTERN PetscErrorCode SNESMultiblockSetFields(SNES, const char [], PetscInt, const PetscInt *);
    715: PETSC_EXTERN PetscErrorCode SNESMultiblockSetIS(SNES, const char [], IS);
    716: PETSC_EXTERN PetscErrorCode SNESMultiblockSetBlockSize(SNES, PetscInt);
    717: PETSC_EXTERN PetscErrorCode SNESMultiblockSetType(SNES, PCCompositeType);

    719: /*J
    720:     SNESMSType - String with the name of a PETSc SNESMS method.

    722:    Level: intermediate

    724: .seealso: SNESMSSetType(), SNES
    725: J*/
    726: typedef const char* SNESMSType;
    727: #define SNESMSM62       "m62"
    728: #define SNESMSEULER     "euler"
    729: #define SNESMSJAMESON83 "jameson83"
    730: #define SNESMSVLTP21    "vltp21"
    731: #define SNESMSVLTP31    "vltp31"
    732: #define SNESMSVLTP41    "vltp41"
    733: #define SNESMSVLTP51    "vltp51"
    734: #define SNESMSVLTP61    "vltp61"

    736: PETSC_EXTERN PetscErrorCode SNESMSRegister(SNESMSType,PetscInt,PetscInt,PetscReal,const PetscReal[],const PetscReal[],const PetscReal[]);
    737: PETSC_EXTERN PetscErrorCode SNESMSSetType(SNES,SNESMSType);
    738: PETSC_EXTERN PetscErrorCode SNESMSFinalizePackage(void);
    739: PETSC_EXTERN PetscErrorCode SNESMSInitializePackage(void);
    740: PETSC_EXTERN PetscErrorCode SNESMSRegisterDestroy(void);

    742: /* routines for NGMRES solver */

    744: typedef enum {
    745:   SNES_NGMRES_RESTART_NONE       = 0,
    746:   SNES_NGMRES_RESTART_PERIODIC   = 1,
    747:   SNES_NGMRES_RESTART_DIFFERENCE = 2} SNESNGMRESRestartType;
    748: PETSC_EXTERN const char *const SNESNGMRESRestartTypes[];

    750: typedef enum {
    751:   SNES_NGMRES_SELECT_NONE       = 0,
    752:   SNES_NGMRES_SELECT_DIFFERENCE = 1,
    753:   SNES_NGMRES_SELECT_LINESEARCH = 2} SNESNGMRESSelectType;
    754: PETSC_EXTERN const char *const SNESNGMRESSelectTypes[];

    756: PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartType(SNES, SNESNGMRESRestartType);
    757: PETSC_EXTERN PetscErrorCode SNESNGMRESSetSelectType(SNES, SNESNGMRESSelectType);
    758: PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartFmRise(SNES, PetscBool);
    759: PETSC_EXTERN PetscErrorCode SNESNGMRESGetRestartFmRise(SNES, PetscBool*);

    761: /* routines for NCG solver */

    763: typedef enum {
    764:   SNES_NCG_FR    = 0,
    765:   SNES_NCG_PRP   = 1,
    766:   SNES_NCG_HS    = 2,
    767:   SNES_NCG_DY    = 3,
    768:   SNES_NCG_CD    = 4} SNESNCGType;
    769: PETSC_EXTERN const char *const SNESNCGTypes[];

    771: PETSC_EXTERN PetscErrorCode SNESNCGSetType(SNES, SNESNCGType);

    773: typedef enum {SNES_QN_SCALE_DEFAULT    = 0,
    774:               SNES_QN_SCALE_NONE       = 1,
    775:               SNES_QN_SCALE_SHANNO     = 2,
    776:               SNES_QN_SCALE_LINESEARCH = 3,
    777:               SNES_QN_SCALE_JACOBIAN   = 4} SNESQNScaleType;
    778: PETSC_EXTERN const char *const SNESQNScaleTypes[];
    779: typedef enum {SNES_QN_RESTART_DEFAULT  = 0,
    780:               SNES_QN_RESTART_NONE     = 1,
    781:               SNES_QN_RESTART_POWELL   = 2,
    782:               SNES_QN_RESTART_PERIODIC = 3} SNESQNRestartType;
    783: PETSC_EXTERN const char *const SNESQNRestartTypes[];
    784: typedef enum {SNES_QN_LBFGS      = 0,
    785:               SNES_QN_BROYDEN    = 1,
    786:               SNES_QN_BADBROYDEN = 2
    787:              } SNESQNType;
    788: PETSC_EXTERN const char *const SNESQNTypes[];

    790: PETSC_EXTERN PetscErrorCode SNESQNSetType(SNES, SNESQNType);
    791: PETSC_EXTERN PetscErrorCode SNESQNSetScaleType(SNES, SNESQNScaleType);
    792: PETSC_EXTERN PetscErrorCode SNESQNSetRestartType(SNES, SNESQNRestartType);

    794: PETSC_EXTERN PetscErrorCode SNESNASMGetType(SNES,PCASMType*);
    795: PETSC_EXTERN PetscErrorCode SNESNASMSetType(SNES,PCASMType);
    796: PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomains(SNES,PetscInt*,SNES**,VecScatter**,VecScatter**,VecScatter**);
    797: PETSC_EXTERN PetscErrorCode SNESNASMSetSubdomains(SNES,PetscInt,SNES*,VecScatter*,VecScatter*,VecScatter*);
    798: PETSC_EXTERN PetscErrorCode SNESNASMSetDamping(SNES,PetscReal);
    799: PETSC_EXTERN PetscErrorCode SNESNASMGetDamping(SNES,PetscReal*);
    800: PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomainVecs(SNES,PetscInt*,Vec**,Vec**,Vec**,Vec**);
    801: PETSC_EXTERN PetscErrorCode SNESNASMSetComputeFinalJacobian(SNES,PetscBool);
    802: PETSC_EXTERN PetscErrorCode SNESNASMGetSNES(SNES,PetscInt,SNES *);
    803: PETSC_EXTERN PetscErrorCode SNESNASMGetNumber(SNES,PetscInt*);
    804: PETSC_EXTERN PetscErrorCode SNESNASMSetWeight(SNES,Vec);

    806: typedef enum {SNES_COMPOSITE_ADDITIVE,SNES_COMPOSITE_MULTIPLICATIVE,SNES_COMPOSITE_ADDITIVEOPTIMAL} SNESCompositeType;
    807: PETSC_EXTERN const char *const SNESCompositeTypes[];

    809: PETSC_EXTERN PetscErrorCode SNESCompositeSetType(SNES,SNESCompositeType);
    810: PETSC_EXTERN PetscErrorCode SNESCompositeAddSNES(SNES,SNESType);
    811: PETSC_EXTERN PetscErrorCode SNESCompositeGetSNES(SNES,PetscInt,SNES *);
    812: PETSC_EXTERN PetscErrorCode SNESCompositeGetNumber(SNES,PetscInt*);
    813: PETSC_EXTERN PetscErrorCode SNESCompositeSetDamping(SNES,PetscInt,PetscReal);

    815: /*E
    816:     SNESFASType - Determines the type of nonlinear multigrid method that is run.

    818:    Level: beginner

    820:    Values:
    821: +  SNES_FAS_MULTIPLICATIVE (default) - traditional V or W cycle as determined by SNESFASSetCycles()
    822: .  SNES_FAS_ADDITIVE                 - additive FAS cycle
    823: .  SNES_FAS_FULL                     - full FAS cycle
    824: -  SNES_FAS_KASKADE                  - Kaskade FAS cycle
    825: .seealso: PCMGSetType(), PCMGType

    827: E*/
    828: typedef enum { SNES_FAS_MULTIPLICATIVE, SNES_FAS_ADDITIVE, SNES_FAS_FULL, SNES_FAS_KASKADE } SNESFASType;
    829: PETSC_EXTERN const char *const  SNESFASTypes[];

    831: /* called on the finest level FAS instance*/
    832: PETSC_EXTERN PetscErrorCode SNESFASSetType(SNES, SNESFASType);
    833: PETSC_EXTERN PetscErrorCode SNESFASGetType(SNES, SNESFASType*);
    834: PETSC_EXTERN PetscErrorCode SNESFASSetLevels(SNES, PetscInt, MPI_Comm *);
    835: PETSC_EXTERN PetscErrorCode SNESFASGetLevels(SNES, PetscInt *);
    836: PETSC_EXTERN PetscErrorCode SNESFASGetCycleSNES(SNES, PetscInt, SNES*);
    837: PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothUp(SNES, PetscInt);
    838: PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothDown(SNES, PetscInt);
    839: PETSC_EXTERN PetscErrorCode SNESFASSetCycles(SNES, PetscInt);
    840: PETSC_EXTERN PetscErrorCode SNESFASSetMonitor(SNES, PetscViewerAndFormat *, PetscBool);
    841: PETSC_EXTERN PetscErrorCode SNESFASSetLog(SNES, PetscBool);

    843: PETSC_EXTERN PetscErrorCode SNESFASSetGalerkin(SNES, PetscBool);
    844: PETSC_EXTERN PetscErrorCode SNESFASGetGalerkin(SNES, PetscBool*);
    845: PETSC_EXTERN PetscErrorCode SNESFASGalerkinFunctionDefault(SNES,Vec,Vec,void*);

    847: /* called on any level -- "Cycle" FAS instance */
    848: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmoother(SNES, SNES*);
    849: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherUp(SNES, SNES*);
    850: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherDown(SNES, SNES*);
    851: PETSC_EXTERN PetscErrorCode SNESFASCycleGetCorrection(SNES, SNES*);
    852: PETSC_EXTERN PetscErrorCode SNESFASCycleGetInterpolation(SNES, Mat*);
    853: PETSC_EXTERN PetscErrorCode SNESFASCycleGetRestriction(SNES, Mat*);
    854: PETSC_EXTERN PetscErrorCode SNESFASCycleGetInjection(SNES, Mat*);
    855: PETSC_EXTERN PetscErrorCode SNESFASCycleGetRScale(SNES, Vec*);
    856: PETSC_EXTERN PetscErrorCode SNESFASCycleSetCycles(SNES, PetscInt);
    857: PETSC_EXTERN PetscErrorCode SNESFASCycleIsFine(SNES, PetscBool*);

    859: /* called on the (outer) finest level FAS to set/get parameters on any level instance */
    860: PETSC_EXTERN PetscErrorCode SNESFASSetInterpolation(SNES, PetscInt, Mat);
    861: PETSC_EXTERN PetscErrorCode SNESFASGetInterpolation(SNES, PetscInt, Mat*);
    862: PETSC_EXTERN PetscErrorCode SNESFASSetRestriction(SNES, PetscInt, Mat);
    863: PETSC_EXTERN PetscErrorCode SNESFASGetRestriction(SNES, PetscInt, Mat*);
    864: PETSC_EXTERN PetscErrorCode SNESFASSetInjection(SNES, PetscInt, Mat);
    865: PETSC_EXTERN PetscErrorCode SNESFASGetInjection(SNES, PetscInt, Mat*);
    866: PETSC_EXTERN PetscErrorCode SNESFASSetRScale(SNES, PetscInt, Vec);
    867: PETSC_EXTERN PetscErrorCode SNESFASGetRScale(SNES, PetscInt, Vec*);
    868: PETSC_EXTERN PetscErrorCode SNESFASSetContinuation(SNES,PetscBool);

    870: PETSC_EXTERN PetscErrorCode SNESFASGetSmoother(SNES,     PetscInt, SNES*);
    871: PETSC_EXTERN PetscErrorCode SNESFASGetSmootherUp(SNES,   PetscInt, SNES*);
    872: PETSC_EXTERN PetscErrorCode SNESFASGetSmootherDown(SNES, PetscInt, SNES*);
    873: PETSC_EXTERN PetscErrorCode SNESFASGetCoarseSolve(SNES, SNES*);

    875: /* parameters for full FAS */
    876: PETSC_EXTERN PetscErrorCode SNESFASFullSetDownSweep(SNES,PetscBool);
    877: PETSC_EXTERN PetscErrorCode SNESFASCreateCoarseVec(SNES,Vec*);
    878: PETSC_EXTERN PetscErrorCode SNESFASRestrict(SNES,Vec,Vec);

    880: PETSC_EXTERN PetscErrorCode DMSNESCheckFromOptions(SNES,Vec,PetscErrorCode (**)(PetscInt,PetscReal,const PetscReal[],PetscInt,PetscScalar*,void*),void**);

    882: #endif