Actual source code: tsreg.c

petsc-master 2019-07-15
Report Typos and Errors
  1:  #include <petsc/private/tsimpl.h>

  3: PetscFunctionList TSList              = NULL;
  4: PetscBool         TSRegisterAllCalled = PETSC_FALSE;

  6: /*@C
  7:   TSSetType - Sets the method to be used as the timestepping solver.

  9:   Collective on TS

 11:   Input Parameters:
 12: + ts   - The TS context
 13: - type - A known method

 15:   Options Database Command:
 16: . -ts_type <type> - Sets the method; use -help for a list of available methods (for instance, euler)

 18:    Notes:
 19:    See "petsc/include/petscts.h" for available methods (for instance)
 20: +  TSEULER - Euler
 21: .  TSSUNDIALS - SUNDIALS interface
 22: .  TSBEULER - Backward Euler
 23: -  TSPSEUDO - Pseudo-timestepping

 25:    Normally, it is best to use the TSSetFromOptions() command and
 26:    then set the TS type from the options database rather than by using
 27:    this routine.  Using the options database provides the user with
 28:    maximum flexibility in evaluating the many different solvers.
 29:    The TSSetType() routine is provided for those situations where it
 30:    is necessary to set the timestepping solver independently of the
 31:    command line or options database.  This might be the case, for example,
 32:    when the choice of solver changes during the execution of the
 33:    program, and the user's application is taking responsibility for
 34:    choosing the appropriate method.  In other words, this routine is
 35:    not for beginners.

 37:    Level: intermediate

 39: .seealso: TS, TSSolve(), TSCreate(), TSSetFromOptions(), TSDestroy(), TSType

 41: @*/
 42: PetscErrorCode  TSSetType(TS ts,TSType type)
 43: {
 44:   PetscErrorCode (*r)(TS);
 45:   PetscBool      match;

 51:   PetscObjectTypeCompare((PetscObject) ts, type, &match);
 52:   if (match) return(0);

 54:   PetscFunctionListFind(TSList,type,&r);
 55:   if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown TS type: %s", type);
 56:   if (ts->ops->destroy) {
 57:     (*(ts)->ops->destroy)(ts);
 58:   }
 59:   PetscMemzero(ts->ops,sizeof(*ts->ops));
 60:   ts->usessnes           = PETSC_FALSE;
 61:   ts->default_adapt_type = TSADAPTNONE;

 63:   ts->setupcalled = PETSC_FALSE;

 65:   PetscObjectChangeTypeName((PetscObject)ts, type);
 66:   (*r)(ts);
 67:   return(0);
 68: }

 70: /*@C
 71:   TSGetType - Gets the TS method type (as a string).

 73:   Not Collective

 75:   Input Parameter:
 76: . ts - The TS

 78:   Output Parameter:
 79: . type - The name of TS method

 81:   Level: intermediate

 83: .seealso TSSetType()
 84: @*/
 85: PetscErrorCode  TSGetType(TS ts, TSType *type)
 86: {
 90:   *type = ((PetscObject)ts)->type_name;
 91:   return(0);
 92: }

 94: /*--------------------------------------------------------------------------------------------------------------------*/

 96: /*@C
 97:   TSRegister - Adds a creation method to the TS package.

 99:   Not Collective

101:   Input Parameters:
102: + name        - The name of a new user-defined creation routine
103: - create_func - The creation routine itself

105:   Notes:
106:   TSRegister() may be called multiple times to add several user-defined tses.

108:   Sample usage:
109: .vb
110:   TSRegister("my_ts",  MyTSCreate);
111: .ve

113:   Then, your ts type can be chosen with the procedural interface via
114: .vb
115:     TS ts;
116:     TSCreate(MPI_Comm, &ts);
117:     TSSetType(ts, "my_ts")
118: .ve
119:   or at runtime via the option
120: .vb
121:     -ts_type my_ts
122: .ve

124:   Level: advanced

126: .seealso: TSRegisterAll(), TSRegisterDestroy()
127: @*/
128: PetscErrorCode  TSRegister(const char sname[], PetscErrorCode (*function)(TS))
129: {

133:   TSInitializePackage();
134:   PetscFunctionListAdd(&TSList,sname,function);
135:   return(0);
136: }