xref: /petsc/src/snes/interface/dlregissnes.c (revision 5b6bfdb9644f185dbf5e5a09b808ec241507e1e7)
1 
2 #include <petsc/private/snesimpl.h>
3 #include <petsc/private/linesearchimpl.h>
4 
5 static PetscBool SNESPackageInitialized = PETSC_FALSE;
6 
7 /*@C
8   SNESFinalizePackage - This function destroys everything in the Petsc interface to the SNES package. It is
9   called from PetscFinalize().
10 
11   Level: developer
12 
13 .keywords: Petsc, destroy, package, mathematica
14 .seealso: PetscFinalize()
15 @*/
16 PetscErrorCode  SNESFinalizePackage(void)
17 {
18   PetscErrorCode ierr;
19 
20   PetscFunctionBegin;
21   ierr = PetscFunctionListDestroy(&SNESList);CHKERRQ(ierr);
22   ierr = PetscFunctionListDestroy(&SNESLineSearchList);CHKERRQ(ierr);
23   SNESPackageInitialized = PETSC_FALSE;
24   SNESRegisterAllCalled  = PETSC_FALSE;
25   SNESLineSearchRegisterAllCalled = PETSC_FALSE;
26   PetscFunctionReturn(0);
27 }
28 
29 /*@C
30   SNESInitializePackage - This function initializes everything in the SNES package. It is called
31   from PetscDLLibraryRegister() when using dynamic libraries, and on the first call to SNESCreate()
32   when using static libraries.
33 
34   Level: developer
35 
36 .keywords: SNES, initialize, package
37 .seealso: PetscInitialize()
38 @*/
39 PetscErrorCode  SNESInitializePackage(void)
40 {
41   char           logList[256];
42   PetscBool      opt,pkg,cls;
43   PetscErrorCode ierr;
44 
45   PetscFunctionBegin;
46   if (SNESPackageInitialized) PetscFunctionReturn(0);
47   SNESPackageInitialized = PETSC_TRUE;
48   /* Initialize subpackages */
49   ierr = SNESMSInitializePackage();CHKERRQ(ierr);
50   /* Register Classes */
51   ierr = PetscClassIdRegister("SNES",&SNES_CLASSID);CHKERRQ(ierr);
52   ierr = PetscClassIdRegister("SNESLineSearch",&SNESLINESEARCH_CLASSID);CHKERRQ(ierr);
53   ierr = PetscClassIdRegister("DMSNES",&DMSNES_CLASSID);CHKERRQ(ierr);
54   /* Register Constructors */
55   ierr = SNESRegisterAll();CHKERRQ(ierr);
56   ierr = SNESLineSearchRegisterAll();CHKERRQ(ierr);
57   /* Register Events */
58   ierr = PetscLogEventRegister("SNESSolve",            SNES_CLASSID,&SNES_Solve);CHKERRQ(ierr);
59   ierr = PetscLogEventRegister("SNESFunctionEval",     SNES_CLASSID,&SNES_FunctionEval);CHKERRQ(ierr);
60   ierr = PetscLogEventRegister("SNESObjectiveEval",    SNES_CLASSID,&SNES_ObjectiveEval);CHKERRQ(ierr);
61   ierr = PetscLogEventRegister("SNESNGSEval",          SNES_CLASSID,&SNES_NGSEval);CHKERRQ(ierr);
62   ierr = PetscLogEventRegister("SNESNGSFuncEval",      SNES_CLASSID,&SNES_NGSFuncEval);CHKERRQ(ierr);
63   ierr = PetscLogEventRegister("SNESJacobianEval",     SNES_CLASSID,&SNES_JacobianEval);CHKERRQ(ierr);
64   ierr = PetscLogEventRegister("SNESLineSearch",       SNESLINESEARCH_CLASSID,&SNESLINESEARCH_Apply);CHKERRQ(ierr);
65   ierr = PetscLogEventRegister("SNESNPCSolve",         SNES_CLASSID,&SNES_NPCSolve);CHKERRQ(ierr);
66   /* Process info exclusions */
67   ierr = PetscOptionsGetString(NULL,NULL,"-info_exclude",logList,sizeof(logList),&opt);CHKERRQ(ierr);
68   if (opt) {
69     ierr = PetscStrInList("snes",logList,',',&pkg);CHKERRQ(ierr);
70     if (pkg) {ierr = PetscInfoDeactivateClass(SNES_CLASSID);CHKERRQ(ierr);}
71     ierr = PetscStrInList("dm",logList,',',&cls);CHKERRQ(ierr);
72     if (pkg || cls) {ierr = PetscInfoDeactivateClass(DMSNES_CLASSID);CHKERRQ(ierr);}
73     ierr = PetscStrInList("sneslinesearch",logList,',',&cls);CHKERRQ(ierr);
74     if (pkg || cls) {ierr = PetscInfoDeactivateClass(SNESLINESEARCH_CLASSID);CHKERRQ(ierr);}
75   }
76   /* Process summary exclusions */
77   ierr = PetscOptionsGetString(NULL,NULL,"-log_exclude",logList,sizeof(logList),&opt);CHKERRQ(ierr);
78   if (opt) {
79     ierr = PetscStrInList("snes",logList,',',&pkg);CHKERRQ(ierr);
80     if (pkg) {ierr = PetscLogEventDeactivateClass(SNES_CLASSID);CHKERRQ(ierr);}
81     ierr = PetscStrInList("dm",logList,',',&cls);CHKERRQ(ierr);
82     if (pkg || cls) {ierr = PetscLogEventDeactivateClass(DMSNES_CLASSID);CHKERRQ(ierr);}
83     ierr = PetscStrInList("sneslinesearch",logList,',',&cls);CHKERRQ(ierr);
84     if (pkg || cls) {ierr = PetscLogEventDeactivateClass(SNESLINESEARCH_CLASSID);CHKERRQ(ierr);}
85   }
86   /* Register package finalizer */
87   ierr = PetscRegisterFinalize(SNESFinalizePackage);CHKERRQ(ierr);
88   PetscFunctionReturn(0);
89 }
90 
91 #if defined(PETSC_HAVE_DYNAMIC_LIBRARIES)
92 /*
93   PetscDLLibraryRegister - This function is called when the dynamic library it is in is opened.
94 
95   This registers all of the SNES methods that are in the basic PETSc libpetscsnes library.
96 
97  */
98 PETSC_EXTERN PetscErrorCode PetscDLLibraryRegister_petscsnes(void)
99 {
100   PetscErrorCode ierr;
101 
102   PetscFunctionBegin;
103   ierr = SNESInitializePackage();CHKERRQ(ierr);
104   PetscFunctionReturn(0);
105 }
106 
107 #endif /* PETSC_HAVE_DYNAMIC_LIBRARIES */
108