xref: /petsc/src/snes/interface/dlregissnes.c (revision fc8a9adeb7fcdc98711d755fa2dc544ddccf0f3e)
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_petscsnes() when using dynamic libraries, and on the first call to SNESCreate()
32   when using shared or 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("DMSNES",&DMSNES_CLASSID);CHKERRQ(ierr);
53   ierr = PetscClassIdRegister("SNESLineSearch",&SNESLINESEARCH_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("SNESSetUp",            SNES_CLASSID,&SNES_Setup);CHKERRQ(ierr);
60   ierr = PetscLogEventRegister("SNESFunctionEval",     SNES_CLASSID,&SNES_FunctionEval);CHKERRQ(ierr);
61   ierr = PetscLogEventRegister("SNESObjectiveEval",    SNES_CLASSID,&SNES_ObjectiveEval);CHKERRQ(ierr);
62   ierr = PetscLogEventRegister("SNESNGSEval",          SNES_CLASSID,&SNES_NGSEval);CHKERRQ(ierr);
63   ierr = PetscLogEventRegister("SNESNGSFuncEval",      SNES_CLASSID,&SNES_NGSFuncEval);CHKERRQ(ierr);
64   ierr = PetscLogEventRegister("SNESJacobianEval",     SNES_CLASSID,&SNES_JacobianEval);CHKERRQ(ierr);
65   ierr = PetscLogEventRegister("SNESNPCSolve",         SNES_CLASSID,&SNES_NPCSolve);CHKERRQ(ierr);
66   ierr = PetscLogEventRegister("SNESLineSearch",       SNESLINESEARCH_CLASSID,&SNESLINESEARCH_Apply);CHKERRQ(ierr);
67   /* Process info exclusions */
68   ierr = PetscOptionsGetString(NULL,NULL,"-info_exclude",logList,sizeof(logList),&opt);CHKERRQ(ierr);
69   if (opt) {
70     ierr = PetscStrInList("snes",logList,',',&pkg);CHKERRQ(ierr);
71     if (pkg) {ierr = PetscInfoDeactivateClass(SNES_CLASSID);CHKERRQ(ierr);}
72     ierr = PetscStrInList("dm",logList,',',&cls);CHKERRQ(ierr);
73     if (pkg || cls) {ierr = PetscInfoDeactivateClass(DMSNES_CLASSID);CHKERRQ(ierr);}
74     ierr = PetscStrInList("sneslinesearch",logList,',',&cls);CHKERRQ(ierr);
75     if (pkg || cls) {ierr = PetscInfoDeactivateClass(SNESLINESEARCH_CLASSID);CHKERRQ(ierr);}
76   }
77   /* Process summary exclusions */
78   ierr = PetscOptionsGetString(NULL,NULL,"-log_exclude",logList,sizeof(logList),&opt);CHKERRQ(ierr);
79   if (opt) {
80     ierr = PetscStrInList("snes",logList,',',&pkg);CHKERRQ(ierr);
81     if (pkg) {ierr = PetscLogEventExcludeClass(SNES_CLASSID);CHKERRQ(ierr);}
82     ierr = PetscStrInList("dm",logList,',',&cls);CHKERRQ(ierr);
83     if (pkg || cls) {ierr = PetscLogEventExcludeClass(DMSNES_CLASSID);CHKERRQ(ierr);}
84     ierr = PetscStrInList("sneslinesearch",logList,',',&cls);CHKERRQ(ierr);
85     if (pkg || cls) {ierr = PetscLogEventExcludeClass(SNESLINESEARCH_CLASSID);CHKERRQ(ierr);}
86   }
87   /* Register package finalizer */
88   ierr = PetscRegisterFinalize(SNESFinalizePackage);CHKERRQ(ierr);
89   PetscFunctionReturn(0);
90 }
91 
92 #if defined(PETSC_HAVE_DYNAMIC_LIBRARIES)
93 /*
94   PetscDLLibraryRegister - This function is called when the dynamic library it is in is opened.
95 
96   This registers all of the SNES methods that are in the basic PETSc libpetscsnes library.
97 
98  */
99 PETSC_EXTERN PetscErrorCode PetscDLLibraryRegister_petscsnes(void)
100 {
101   PetscErrorCode ierr;
102 
103   PetscFunctionBegin;
104   ierr = SNESInitializePackage();CHKERRQ(ierr);
105   PetscFunctionReturn(0);
106 }
107 
108 #endif /* PETSC_HAVE_DYNAMIC_LIBRARIES */
109