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