Actual source code: aoreg.c

petsc-3.12.0 2019-09-29
Report Typos and Errors

  2:  #include <../src/vec/is/ao/aoimpl.h>

  4: PetscFunctionList AOList              = NULL;
  5: PetscBool         AORegisterAllCalled = PETSC_FALSE;

  7: /*@C
  8:   AOSetType - Builds an application ordering for a particular implementation.

 10:   Collective on AO

 12:   Input Parameters:
 13: + ao    - The AO object
 14: - method - The name of the AO type

 16:   Options Database Key:
 17: . -ao_type <type> - Sets the AO type; use -help for a list of available types

 19:   Notes:
 20:   See "petsc/include/petscao.h" for available AO types (for instance, AOBASIC and AOMEMORYSCALABLE).

 22:   Level: intermediate

 24: .seealso: AOGetType(), AOCreate()
 25: @*/
 26: PetscErrorCode  AOSetType(AO ao, AOType method)
 27: {
 28:   PetscErrorCode (*r)(AO);
 29:   PetscBool      match;

 34:   PetscObjectTypeCompare((PetscObject)ao, method, &match);
 35:   if (match) return(0);

 37:   AORegisterAll();
 38:   PetscFunctionListFind(AOList,method,&r);
 39:   if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown AO type: %s", method);
 40:   if (ao->ops->destroy) {
 41:     (*ao->ops->destroy)(ao);
 42:     ao->ops->destroy = NULL;
 43:   }

 45:   (*r)(ao);
 46:   return(0);
 47: }

 49: /*@C
 50:   AOGetType - Gets the AO type name (as a string) from the AO.

 52:   Not Collective

 54:   Input Parameter:
 55: . ao  - The vector

 57:   Output Parameter:
 58: . type - The AO type name

 60:   Level: intermediate

 62: .seealso: AOSetType(), AOCreate()
 63: @*/
 64: PetscErrorCode  AOGetType(AO ao, AOType *type)
 65: {

 71:   AORegisterAll();
 72:   *type = ((PetscObject)ao)->type_name;
 73:   return(0);
 74: }


 77: /*--------------------------------------------------------------------------------------------------------------------*/

 79: /*@C
 80:   AORegister - Register  an application ordering method

 82:     Not Collective

 84:    Input Parameters:
 85: +   sname - the name of the AO scheme
 86: -   function - the create routine for the application ordering method

 88:   Level: advanced

 90: .seealso:   AOCreate(), AORegisterAll(), AOBASIC, AOADVANCED, AOMAPPING, AOMEMORYSCALABLE

 92: @*/
 93: PetscErrorCode  AORegister(const char sname[], PetscErrorCode (*function)(AO))
 94: {

 98:   AOInitializePackage();
 99:   PetscFunctionListAdd(&AOList,sname,function);
100:   return(0);
101: }