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