xref: /petsc/src/snes/interface/snesregi.c (revision eed5f15bc2a3dc26d54d7c2989531114c489d821)
1eaa2832dSBarry Smith 
2b45d2f2cSJed Brown #include <petsc-private/snesimpl.h>     /*I  "petscsnes.h"  I*/
3fb2e594dSBarry Smith 
48cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_NEWTONLS(SNES);
58cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_NEWTONTR(SNES);
68cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_Test(SNES);
78cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_NRichardson(SNES);
88cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_KSPONLY(SNES);
98cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_VINEWTONRSLS(SNES);
108cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_VINEWTONSSLS(SNES);
118cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_NGMRES(SNES);
128cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_QN(SNES);
138cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_Shell(SNES);
148cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_GS(SNES);
158cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_NCG(SNES);
168cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_FAS(SNES);
178cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_MS(SNES);
188cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_NASM(SNES);
198cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_Anderson(SNES);
208cc058d9SJed Brown PETSC_EXTERN PetscErrorCode SNESCreate_ASPIN(SNES);
21*eed5f15bSPeter Brune PETSC_EXTERN PetscErrorCode SNESCreate_Composite(SNES);
22eaa2832dSBarry Smith 
231e633543SBarry Smith const char *SNESConvergedReasons_Shifted[] = {" "," ","DIVERGED_LOCAL_MIN","DIVERGED_INNER","DIVERGED_LINE_SEARCH","DIVERGED_MAX_IT",
2464075487SBarry Smith                                               "DIVERGED_FNORM_NAN","DIVERGED_LINEAR_SOLVE","DIVERGED_FUNCTION_COUNT","DIVERGED_FUNCTION_DOMAIN",
259dcbbd2bSBarry Smith                                               "CONVERGED_ITERATING"," ","CONVERGED_FNORM_ABS","CONVERGED_FNORM_RELATIVE",
26c60f73f4SPeter Brune                                               "CONVERGED_SNORM_RELATIVE","CONVERGED_ITS"," ","CONVERGED_TR_DELTA","SNESConvergedReason","",0};
277935a769SJed Brown const char *const *SNESConvergedReasons = SNESConvergedReasons_Shifted + 10;
289dcbbd2bSBarry Smith 
29fdacfa88SPeter Brune const char *SNESNormTypes_Shifted[]    = {"DEFAULT","NONE","FUNCTION","INITIALONLY","FINALONLY","INITIALFINALONLY","SNESNormType","SNES_NORM_",0};
30fdacfa88SPeter Brune const char *const *const SNESNormTypes = SNESNormTypes_Shifted + 1;
31fdacfa88SPeter Brune 
3282bf6240SBarry Smith /*
3382bf6240SBarry Smith       This is used by SNESSetType() to make sure that at least one
3482bf6240SBarry Smith     SNESRegisterAll() is called. In general, if there is more than one
3582bf6240SBarry Smith     DLL then SNESRegisterAll() may be called several times.
3682bf6240SBarry Smith */
37ace3abfcSBarry Smith extern PetscBool SNESRegisterAllCalled;
3882bf6240SBarry Smith 
394a2ae208SSatish Balay #undef __FUNCT__
404a2ae208SSatish Balay #define __FUNCT__ "SNESRegisterAll"
4183f0b094SBarry Smith /*@C
4282bf6240SBarry Smith    SNESRegisterAll - Registers all of the nonlinear solver methods in the SNES package.
43eaa2832dSBarry Smith 
44fee21e36SBarry Smith    Not Collective
45fee21e36SBarry Smith 
4636851e7fSLois Curfman McInnes    Level: advanced
4736851e7fSLois Curfman McInnes 
4882bf6240SBarry Smith .keywords: SNES, register, all
49eaa2832dSBarry Smith 
5082bf6240SBarry Smith .seealso:  SNESRegisterDestroy()
51eaa2832dSBarry Smith @*/
52607a6623SBarry Smith PetscErrorCode  SNESRegisterAll(void)
53eaa2832dSBarry Smith {
54dfbe8321SBarry Smith   PetscErrorCode ierr;
5582bf6240SBarry Smith 
563a40ed3dSBarry Smith   PetscFunctionBegin;
574c49b128SBarry Smith   SNESRegisterAllCalled = PETSC_TRUE;
5882bf6240SBarry Smith 
59bdf89e91SBarry Smith   ierr = SNESRegister(SNESNEWTONLS,     SNESCreate_NEWTONLS);CHKERRQ(ierr);
60bdf89e91SBarry Smith   ierr = SNESRegister(SNESNEWTONTR,     SNESCreate_NEWTONTR);CHKERRQ(ierr);
61bdf89e91SBarry Smith   ierr = SNESRegister(SNESTEST,         SNESCreate_Test);CHKERRQ(ierr);
62bdf89e91SBarry Smith   ierr = SNESRegister(SNESNRICHARDSON,  SNESCreate_NRichardson);CHKERRQ(ierr);
63bdf89e91SBarry Smith   ierr = SNESRegister(SNESKSPONLY,      SNESCreate_KSPONLY);CHKERRQ(ierr);
64bdf89e91SBarry Smith   ierr = SNESRegister(SNESVINEWTONRSLS, SNESCreate_VINEWTONRSLS);CHKERRQ(ierr);
65bdf89e91SBarry Smith   ierr = SNESRegister(SNESVINEWTONSSLS, SNESCreate_VINEWTONSSLS);CHKERRQ(ierr);
66bdf89e91SBarry Smith   ierr = SNESRegister(SNESNGMRES,       SNESCreate_NGMRES);CHKERRQ(ierr);
67bdf89e91SBarry Smith   ierr = SNESRegister(SNESQN,           SNESCreate_QN);CHKERRQ(ierr);
68bdf89e91SBarry Smith   ierr = SNESRegister(SNESSHELL,        SNESCreate_Shell);CHKERRQ(ierr);
69bdf89e91SBarry Smith   ierr = SNESRegister(SNESGS,           SNESCreate_GS);CHKERRQ(ierr);
70bdf89e91SBarry Smith   ierr = SNESRegister(SNESNCG,          SNESCreate_NCG);CHKERRQ(ierr);
71bdf89e91SBarry Smith   ierr = SNESRegister(SNESFAS,          SNESCreate_FAS);CHKERRQ(ierr);
72bdf89e91SBarry Smith   ierr = SNESRegister(SNESMS,           SNESCreate_MS);CHKERRQ(ierr);
73bdf89e91SBarry Smith   ierr = SNESRegister(SNESNASM,         SNESCreate_NASM);CHKERRQ(ierr);
74bdf89e91SBarry Smith   ierr = SNESRegister(SNESANDERSON,     SNESCreate_Anderson);CHKERRQ(ierr);
75bdf89e91SBarry Smith   ierr = SNESRegister(SNESASPIN,        SNESCreate_ASPIN);CHKERRQ(ierr);
76*eed5f15bSPeter Brune   ierr = SNESRegister(SNESCOMPOSITE,    SNESCreate_Composite);CHKERRQ(ierr);
773a40ed3dSBarry Smith   PetscFunctionReturn(0);
78eaa2832dSBarry Smith }
79