xref: /petsc/src/vec/is/ao/interface/aoreg.c (revision b122ec5aa1bd4469eb4e0673542fb7de3f411254)
1 
2 #include <../src/vec/is/ao/aoimpl.h>    /*I "petscao.h"  I*/
3 
4 PetscFunctionList AOList              = NULL;
5 PetscBool         AORegisterAllCalled = PETSC_FALSE;
6 
7 /*@C
8   AOSetType - Builds an application ordering for a particular implementation.
9 
10   Collective on AO
11 
12   Input Parameters:
13 + ao    - The AO object
14 - method - The name of the AO type
15 
16   Options Database Key:
17 . -ao_type <type> - Sets the AO type; use -help for a list of available types
18 
19   Notes:
20   See "petsc/include/petscao.h" for available AO types (for instance, AOBASIC and AOMEMORYSCALABLE).
21 
22   Level: intermediate
23 
24 .seealso: AOGetType(), AOCreate()
25 @*/
26 PetscErrorCode  AOSetType(AO ao, AOType method)
27 {
28   PetscErrorCode (*r)(AO);
29   PetscBool      match;
30 
31   PetscFunctionBegin;
32   PetscValidHeaderSpecific(ao, AO_CLASSID,1);
33   CHKERRQ(PetscObjectTypeCompare((PetscObject)ao, method, &match));
34   if (match) PetscFunctionReturn(0);
35 
36   CHKERRQ(AORegisterAll());
37   CHKERRQ(PetscFunctionListFind(AOList,method,&r));
38   PetscCheck(r,PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown AO type: %s", method);
39   if (ao->ops->destroy) {
40     CHKERRQ((*ao->ops->destroy)(ao));
41     ao->ops->destroy = NULL;
42   }
43 
44   CHKERRQ((*r)(ao));
45   PetscFunctionReturn(0);
46 }
47 
48 /*@C
49   AOGetType - Gets the AO type name (as a string) from the AO.
50 
51   Not Collective
52 
53   Input Parameter:
54 . ao  - The vector
55 
56   Output Parameter:
57 . type - The AO type name
58 
59   Level: intermediate
60 
61 .seealso: AOSetType(), AOCreate()
62 @*/
63 PetscErrorCode  AOGetType(AO ao, AOType *type)
64 {
65   PetscFunctionBegin;
66   PetscValidHeaderSpecific(ao, AO_CLASSID,1);
67   PetscValidPointer(type,2);
68   CHKERRQ(AORegisterAll());
69   *type = ((PetscObject)ao)->type_name;
70   PetscFunctionReturn(0);
71 }
72 
73 /*--------------------------------------------------------------------------------------------------------------------*/
74 
75 /*@C
76   AORegister - Register  an application ordering method
77 
78     Not Collective
79 
80    Input Parameters:
81 +   sname - the name of the AO scheme
82 -   function - the create routine for the application ordering method
83 
84   Level: advanced
85 
86 .seealso:   AOCreate(), AORegisterAll(), AOBASIC, AOADVANCED, AOMAPPING, AOMEMORYSCALABLE
87 
88 @*/
89 PetscErrorCode  AORegister(const char sname[], PetscErrorCode (*function)(AO))
90 {
91   PetscFunctionBegin;
92   CHKERRQ(AOInitializePackage());
93   CHKERRQ(PetscFunctionListAdd(&AOList,sname,function));
94   PetscFunctionReturn(0);
95 }
96