xref: /petsc/src/tao/interface/dlregistao.c (revision 58d68138c660dfb4e9f5b03334792cd4f2ffd7cc)
1 #include <petsc/private/taoimpl.h>
2 
3 static PetscBool TaoPackageInitialized = PETSC_FALSE;
4 
5 /*@C
6   TaoFinalizePackage - This function destroys everything in the PETSc/Tao
7   interface to the Tao package. It is called from `PetscFinalize()`.
8 
9   Level: developer
10 @*/
11 PetscErrorCode TaoFinalizePackage(void) {
12   PetscFunctionBegin;
13   PetscCall(PetscFunctionListDestroy(&TaoList));
14   TaoPackageInitialized = PETSC_FALSE;
15   PetscFunctionReturn(0);
16 }
17 
18 /*@C
19   TaoInitializePackage - This function sets up PETSc to use the Tao
20   package.  When using static or shared libraries, this function is called from the
21   first entry to `TaoCreate()`; when using shared or static libraries, it is called
22   from PetscDLLibraryRegister_tao()
23 
24   Level: developer
25 
26 .seealso: `TaoCreate()`
27 @*/
28 PetscErrorCode TaoInitializePackage(void) {
29   char      logList[256];
30   PetscBool opt, pkg;
31 
32   PetscFunctionBegin;
33   if (TaoPackageInitialized) PetscFunctionReturn(0);
34   TaoPackageInitialized = PETSC_TRUE;
35   /* Register Classes */
36   PetscCall(PetscClassIdRegister("Tao", &TAO_CLASSID));
37   /* Register Constructors */
38   PetscCall(TaoRegisterAll());
39   /* Register Events */
40   PetscCall(PetscLogEventRegister("TaoSolve", TAO_CLASSID, &TAO_Solve));
41   PetscCall(PetscLogEventRegister("TaoObjectiveEval", TAO_CLASSID, &TAO_ObjectiveEval));
42   PetscCall(PetscLogEventRegister("TaoGradientEval", TAO_CLASSID, &TAO_GradientEval));
43   PetscCall(PetscLogEventRegister("TaoObjGradEval", TAO_CLASSID, &TAO_ObjGradEval));
44   PetscCall(PetscLogEventRegister("TaoHessianEval", TAO_CLASSID, &TAO_HessianEval));
45   PetscCall(PetscLogEventRegister("TaoConstrEval", TAO_CLASSID, &TAO_ConstraintsEval));
46   PetscCall(PetscLogEventRegister("TaoJacobianEval", TAO_CLASSID, &TAO_JacobianEval));
47   /* Process Info */
48   {
49     PetscClassId classids[1];
50 
51     classids[0] = TAO_CLASSID;
52     PetscCall(PetscInfoProcessClass("tao", 1, classids));
53   }
54   /* Process summary exclusions */
55   PetscCall(PetscOptionsGetString(NULL, NULL, "-log_exclude", logList, sizeof(logList), &opt));
56   if (opt) {
57     PetscCall(PetscStrInList("tao", logList, ',', &pkg));
58     if (pkg) PetscCall(PetscLogEventExcludeClass(TAO_CLASSID));
59   }
60   /* Register package finalizer */
61   PetscCall(PetscRegisterFinalize(TaoFinalizePackage));
62   PetscFunctionReturn(0);
63 }
64 
65 #if defined(PETSC_HAVE_DYNAMIC_LIBRARIES)
66 /*
67   PetscDLLibraryRegister - this function is called when the dynamic library it
68   is in is opened.
69 
70   This registers all of the Tao methods that are in the libtao
71   library.
72 
73   Input Parameter:
74 . path - library path
75 */
76 PETSC_EXTERN PetscErrorCode PetscDLLibraryRegister_petsctao(void) {
77   PetscFunctionBegin;
78   PetscCall(TaoInitializePackage());
79   PetscCall(TaoLineSearchInitializePackage());
80   PetscFunctionReturn(0);
81 }
82 #endif /* PETSC_HAVE_DYNAMIC_LIBRARIES */
83