xref: /petsc/src/tao/interface/dlregistao.c (revision 257f4e5aa63fce47b93517cb665016a4c8ee7c55)
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_",0};
24 const char *const TaoADMMUpdateTypes[]      = {"UPDATE_BASIC","UPDATE_ADAPTIVE","UPDATE_ADAPTIVE_RELAXED","TaoADMMUpdateType","TAO_ADMM_",0};
25 /*@C
26   TaoInitializePackage - This function sets up PETSc to use the Tao
27   package.  When using static or shared libraries, this function is called from the
28   first entry to TaoCreate(); when using shared or static libraries, it is called
29   from PetscDLLibraryRegister_tao()
30 
31   Level: developer
32 
33 .seealso: TaoCreate()
34 @*/
35 PetscErrorCode TaoInitializePackage(void)
36 {
37   char           logList[256];
38   PetscBool      opt,pkg;
39   PetscErrorCode ierr;
40 
41   PetscFunctionBegin;
42 
43   if (TaoPackageInitialized) PetscFunctionReturn(0);
44   TaoPackageInitialized = PETSC_TRUE;
45   /* Register Classes */
46   ierr = PetscClassIdRegister("Tao",&TAO_CLASSID);CHKERRQ(ierr);
47   /* Register Constructors */
48   ierr = TaoRegisterAll();CHKERRQ(ierr);
49   /* Register Events */
50   ierr = PetscLogEventRegister("TaoSolve",         TAO_CLASSID,&TAO_Solve);CHKERRQ(ierr);
51   ierr = PetscLogEventRegister("TaoObjectiveEval", TAO_CLASSID,&TAO_ObjectiveEval);CHKERRQ(ierr);
52   ierr = PetscLogEventRegister("TaoGradientEval",  TAO_CLASSID,&TAO_GradientEval);CHKERRQ(ierr);
53   ierr = PetscLogEventRegister("TaoObjGradEval",   TAO_CLASSID,&TAO_ObjGradEval);CHKERRQ(ierr);
54   ierr = PetscLogEventRegister("TaoHessianEval",   TAO_CLASSID,&TAO_HessianEval);CHKERRQ(ierr);
55   ierr = PetscLogEventRegister("TaoConstrEval",    TAO_CLASSID,&TAO_ConstraintsEval);CHKERRQ(ierr);
56   ierr = PetscLogEventRegister("TaoJacobianEval",  TAO_CLASSID,&TAO_JacobianEval);CHKERRQ(ierr);
57   /* Process info exclusions */
58   ierr = PetscOptionsGetString(NULL,NULL,"-info_exclude",logList,sizeof(logList),&opt);CHKERRQ(ierr);
59   if (opt) {
60     ierr = PetscStrInList("tao",logList,',',&pkg);CHKERRQ(ierr);
61     if (pkg) {ierr = PetscInfoDeactivateClass(TAO_CLASSID);CHKERRQ(ierr);}
62   }
63   /* Process summary exclusions */
64   ierr = PetscOptionsGetString(NULL,NULL,"-log_exclude",logList,sizeof(logList),&opt);CHKERRQ(ierr);
65   if (opt) {
66     ierr = PetscStrInList("tao",logList,',',&pkg);CHKERRQ(ierr);
67     if (pkg) {ierr = PetscLogEventExcludeClass(TAO_CLASSID);CHKERRQ(ierr);}
68   }
69   /* Register package finalizer */
70   ierr = PetscRegisterFinalize(TaoFinalizePackage);CHKERRQ(ierr);
71   PetscFunctionReturn(0);
72 }
73 
74 #ifdef PETSC_USE_DYNAMIC_LIBRARIES
75 /*
76   PetscDLLibraryRegister - this function is called when the dynamic library it
77   is in is opened.
78 
79   This registers all of the Tao methods that are in the libtao
80   library.
81 
82   Input Parameter:
83 . path - library path
84 */
85 
86 PETSC_EXTERN PetscErrorCode PetscDLLibraryRegister_tao(void)
87 {
88     PetscErrorCode ierr;
89 
90     PetscFunctionBegin;
91     ierr = TaoInitializePackage();CHKERRQ(ierr);
92     ierr = TaoLineSearchInitializePackage();CHKERRQ(ierr);
93     PetscFunctionReturn(0);
94 }
95 
96 #endif /* PETSC_USE_DYNAMIC_LIBRARIES */
97