/*@
TSAdaptCreate - create an adaptive controller context for time stepping
Collective on MPI_Comm
Input Parameter:
. comm - The communicator
Output Parameter:
. adapt - new TSAdapt object
Level: developer
Notes:
TSAdapt creation is handled by TS, so users should not need to call this function.
.keywords: TSAdapt, create
.seealso: TSGetAdapt(), TSAdaptSetType(), TSAdaptDestroy()
@*/
PetscErrorCode TSAdaptCreate(MPI_Comm comm,TSAdapt *inadapt)
{
PetscErrorCode ierr;
TSAdapt adapt;
PetscFunctionBegin;
PetscValidPointer(inadapt,1);
*inadapt = NULL;
ierr = TSAdaptInitializePackage();CHKERRQ(ierr);
ierr = PetscHeaderCreate(adapt,TSADAPT_CLASSID,"TSAdapt","Time stepping adaptivity","TS",comm,TSAdaptDestroy,TSAdaptView);CHKERRQ(ierr);
adapt->always_accept = PETSC_FALSE;
adapt->safety = 0.9;
adapt->reject_safety = 0.5;
adapt->clip[0] = 0.1;
adapt->clip[1] = 10.;
adapt->dt_min = 1e-20;
adapt->dt_max = 1e+20;
adapt->ignore_max = -1.0;
adapt->glee_use_local = PETSC_TRUE;
adapt->scale_solve_failed = 0.25;
/* these two safety factors are not public, and they are used only in the TS_EXACTFINALTIME_MATCHSTEP case
to prevent from situations were unreasonably small time steps are taken in order to match the final time */
adapt->matchstepfac[0] = 0.01; /* allow 1% step size increase in the last step */
adapt->matchstepfac[1] = 2.0; /* halve last step if it is greater than what remains divided this factor */
adapt->wnormtype = NORM_2;
adapt->timestepjustdecreased_delay = 0;
*inadapt = adapt;
PetscFunctionReturn(0);
}
/*@C
TSAdaptRegister - adds a TSAdapt implementation
Not Collective
Input Parameters:
+ name_scheme - name of user-defined adaptivity scheme
- routine_create - routine to create method context
Notes:
TSAdaptRegister() may be called multiple times to add several user-defined families.
Sample usage:
.vb
TSAdaptRegister("my_scheme",MySchemeCreate);
.ve
Then, your scheme can be chosen with the procedural interface via
$ TSAdaptSetType(ts,"my_scheme")
or at runtime via the option
$ -ts_adapt_type my_scheme
Level: advanced
.keywords: TSAdapt, register
.seealso: TSAdaptRegisterAll()
@*/
PetscErrorCode TSAdaptRegister(const char sname[],PetscErrorCode (*function)(TSAdapt))
{
PetscErrorCode ierr;
PetscFunctionBegin;
ierr = TSAdaptInitializePackage();CHKERRQ(ierr);
ierr = PetscFunctionListAdd(&TSAdaptList,sname,function);CHKERRQ(ierr);
PetscFunctionReturn(0);
}
/*@C
TSInitializePackage - This function initializes everything in the TS package. It is called
from PetscDLLibraryRegister() when using dynamic libraries, and on the first call to TSCreate()
when using static libraries.
Level: developer
.keywords: TS, initialize, package
.seealso: PetscInitialize()
@*/
PetscErrorCode TSInitializePackage(void)
{
char logList[256];
char *className;
PetscBool opt;
PetscErrorCode ierr;
PetscFunctionBegin;
if (TSPackageInitialized) PetscFunctionReturn(0);
TSPackageInitialized = PETSC_TRUE;
/* Inialize subpackages */
ierr = TSGLLEInitializePackage();CHKERRQ(ierr);
ierr = TSRKInitializePackage();CHKERRQ(ierr);
ierr = TSGLEEInitializePackage();CHKERRQ(ierr);
ierr = TSARKIMEXInitializePackage();CHKERRQ(ierr);
ierr = TSRosWInitializePackage();CHKERRQ(ierr);
ierr = TSSSPInitializePackage();CHKERRQ(ierr);
ierr = TSAdaptInitializePackage();CHKERRQ(ierr);
ierr = TSGLLEAdaptInitializePackage();CHKERRQ(ierr);
/* Register Classes */
ierr = PetscClassIdRegister("TS",&TS_CLASSID);CHKERRQ(ierr);
ierr = PetscClassIdRegister("DMTS",&DMTS_CLASSID);CHKERRQ(ierr);
ierr = PetscClassIdRegister("TSTrajectory",&TSTRAJECTORY_CLASSID);CHKERRQ(ierr);
/* Register Constructors */
ierr = TSRegisterAll();CHKERRQ(ierr);
ierr = TSTrajectoryRegisterAll();CHKERRQ(ierr);
/* Register Events */
ierr = PetscLogEventRegister("TSAdjointStep",TS_CLASSID,&TS_AdjointStep);CHKERRQ(ierr);
ierr = PetscLogEventRegister("TSTrajSet",TSTRAJECTORY_CLASSID,&TSTrajectory_Set);CHKERRQ(ierr);
ierr = PetscLogEventRegister("TSTrajGet",TSTRAJECTORY_CLASSID,&TSTrajectory_Get);CHKERRQ(ierr);
ierr = PetscLogEventRegister("TSTrajDiskWrite",TS_CLASSID,&TSTrajectory_DiskWrite);CHKERRQ(ierr);
ierr = PetscLogEventRegister("TSTrajDiskRead",TS_CLASSID,&TSTrajectory_DiskRead);CHKERRQ(ierr);
ierr = PetscLogEventRegister("TSStep",TS_CLASSID,&TS_Step);CHKERRQ(ierr);
ierr = PetscLogEventRegister("TSPseudoCmptTStp",TS_CLASSID,&TS_PseudoComputeTimeStep);CHKERRQ(ierr);
ierr = PetscLogEventRegister("TSFunctionEval",TS_CLASSID,&TS_FunctionEval);CHKERRQ(ierr);
ierr = PetscLogEventRegister("TSJacobianEval",TS_CLASSID,&TS_JacobianEval);CHKERRQ(ierr);
/* Process info exclusions */
ierr = PetscOptionsGetString(NULL,NULL, "-info_exclude", logList, 256, &opt);CHKERRQ(ierr);
if (opt) {
ierr = PetscStrstr(logList, "ts", &className);CHKERRQ(ierr);
if (className) {
ierr = PetscInfoDeactivateClass(TS_CLASSID);CHKERRQ(ierr);
}
}
/* Process summary exclusions */
ierr = PetscOptionsGetString(NULL,NULL, "-log_exclude", logList, 256, &opt);CHKERRQ(ierr);
if (opt) {
ierr = PetscStrstr(logList, "ts", &className);CHKERRQ(ierr);
if (className) {
ierr = PetscLogEventDeactivateClass(TS_CLASSID);CHKERRQ(ierr);
}
}
ierr = PetscRegisterFinalize(TSFinalizePackage);CHKERRQ(ierr);
PetscFunctionReturn(0);
}
/*@
TSAdaptCreate - create an adaptive controller context for time stepping
Collective on MPI_Comm
Input Parameter:
. comm - The communicator
Output Parameter:
. adapt - new TSAdapt object
Level: developer
Notes:
TSAdapt creation is handled by TS, so users should not need to call this function.
.keywords: TSAdapt, create
.seealso: TSGetAdapt(), TSAdaptSetType(), TSAdaptDestroy()
@*/
PetscErrorCode TSAdaptCreate(MPI_Comm comm,TSAdapt *inadapt)
{
PetscErrorCode ierr;
TSAdapt adapt;
PetscFunctionBegin;
PetscValidPointer(inadapt,1);
*inadapt = NULL;
ierr = TSAdaptInitializePackage();CHKERRQ(ierr);
ierr = PetscHeaderCreate(adapt,TSADAPT_CLASSID,"TSAdapt","Time stepping adaptivity","TS",comm,TSAdaptDestroy,TSAdaptView);CHKERRQ(ierr);
adapt->dt_min = 1e-20;
adapt->dt_max = 1e50;
adapt->scale_solve_failed = 0.25;
adapt->wnormtype = NORM_2;
ierr = TSAdaptSetType(adapt,TSADAPTBASIC);CHKERRQ(ierr);
*inadapt = adapt;
PetscFunctionReturn(0);
}
