184df9cb4SJed Brown 2*b45d2f2cSJed Brown #include <petsc-private/tsimpl.h> /*I "petscts.h" I*/ 384df9cb4SJed Brown 484df9cb4SJed Brown static PetscFList TSAdaptList; 584df9cb4SJed Brown static PetscBool TSAdaptPackageInitialized; 684df9cb4SJed Brown static PetscBool TSAdaptRegisterAllCalled; 784df9cb4SJed Brown static PetscClassId TSADAPT_CLASSID; 884df9cb4SJed Brown 984df9cb4SJed Brown EXTERN_C_BEGIN 1084df9cb4SJed Brown PetscErrorCode TSAdaptCreate_Basic(TSAdapt); 11b0f836d7SJed Brown PetscErrorCode TSAdaptCreate_None(TSAdapt); 128d59e960SJed Brown PetscErrorCode TSAdaptCreate_CFL(TSAdapt); 1384df9cb4SJed Brown EXTERN_C_END 1484df9cb4SJed Brown 1584df9cb4SJed Brown #undef __FUNCT__ 1684df9cb4SJed Brown #define __FUNCT__ "TSAdaptRegister" 1784df9cb4SJed Brown /*@C 1884df9cb4SJed Brown TSAdaptRegister - see TSAdaptRegisterDynamic() 1984df9cb4SJed Brown 2084df9cb4SJed Brown Level: advanced 2184df9cb4SJed Brown @*/ 2284df9cb4SJed Brown PetscErrorCode TSAdaptRegister(const char sname[],const char path[],const char name[],PetscErrorCode (*function)(TSAdapt)) 2384df9cb4SJed Brown { 2484df9cb4SJed Brown PetscErrorCode ierr; 2584df9cb4SJed Brown char fullname[PETSC_MAX_PATH_LEN]; 2684df9cb4SJed Brown 2784df9cb4SJed Brown PetscFunctionBegin; 2884df9cb4SJed Brown ierr = PetscFListConcat(path,name,fullname);CHKERRQ(ierr); 2984df9cb4SJed Brown ierr = PetscFListAdd(&TSAdaptList,sname,fullname,(void(*)(void))function);CHKERRQ(ierr); 3084df9cb4SJed Brown PetscFunctionReturn(0); 3184df9cb4SJed Brown } 3284df9cb4SJed Brown 3384df9cb4SJed Brown #undef __FUNCT__ 3484df9cb4SJed Brown #define __FUNCT__ "TSAdaptRegisterAll" 3584df9cb4SJed Brown /*@C 3684df9cb4SJed Brown TSAdaptRegisterAll - Registers all of the adaptivity schemes in TSAdapt 3784df9cb4SJed Brown 3884df9cb4SJed Brown Not Collective 3984df9cb4SJed Brown 4084df9cb4SJed Brown Level: advanced 4184df9cb4SJed Brown 4284df9cb4SJed Brown .keywords: TSAdapt, register, all 4384df9cb4SJed Brown 4484df9cb4SJed Brown .seealso: TSAdaptRegisterDestroy() 4584df9cb4SJed Brown @*/ 4684df9cb4SJed Brown PetscErrorCode TSAdaptRegisterAll(const char path[]) 4784df9cb4SJed Brown { 4884df9cb4SJed Brown PetscErrorCode ierr; 4984df9cb4SJed Brown 5084df9cb4SJed Brown PetscFunctionBegin; 5184df9cb4SJed Brown ierr = TSAdaptRegisterDynamic(TSADAPTBASIC,path,"TSAdaptCreate_Basic",TSAdaptCreate_Basic);CHKERRQ(ierr); 52b0f836d7SJed Brown ierr = TSAdaptRegisterDynamic(TSADAPTNONE, path,"TSAdaptCreate_None", TSAdaptCreate_None);CHKERRQ(ierr); 538d59e960SJed Brown ierr = TSAdaptRegisterDynamic(TSADAPTCFL, path,"TSAdaptCreate_CFL", TSAdaptCreate_CFL);CHKERRQ(ierr); 5484df9cb4SJed Brown PetscFunctionReturn(0); 5584df9cb4SJed Brown } 5684df9cb4SJed Brown 5784df9cb4SJed Brown #undef __FUNCT__ 5884df9cb4SJed Brown #define __FUNCT__ "TSAdaptFinalizePackage" 5984df9cb4SJed Brown /*@C 6084df9cb4SJed Brown TSFinalizePackage - This function destroys everything in the TS package. It is 6184df9cb4SJed Brown called from PetscFinalize(). 6284df9cb4SJed Brown 6384df9cb4SJed Brown Level: developer 6484df9cb4SJed Brown 6584df9cb4SJed Brown .keywords: Petsc, destroy, package 6684df9cb4SJed Brown .seealso: PetscFinalize() 6784df9cb4SJed Brown @*/ 6884df9cb4SJed Brown PetscErrorCode TSAdaptFinalizePackage(void) 6984df9cb4SJed Brown { 7084df9cb4SJed Brown PetscFunctionBegin; 7184df9cb4SJed Brown TSAdaptPackageInitialized = PETSC_FALSE; 7284df9cb4SJed Brown TSAdaptRegisterAllCalled = PETSC_FALSE; 7384df9cb4SJed Brown TSAdaptList = PETSC_NULL; 7484df9cb4SJed Brown PetscFunctionReturn(0); 7584df9cb4SJed Brown } 7684df9cb4SJed Brown 7784df9cb4SJed Brown #undef __FUNCT__ 7884df9cb4SJed Brown #define __FUNCT__ "TSAdaptInitializePackage" 7984df9cb4SJed Brown /*@C 8084df9cb4SJed Brown TSAdaptInitializePackage - This function initializes everything in the TSAdapt package. It is 8184df9cb4SJed Brown called from PetscDLLibraryRegister() when using dynamic libraries, and on the first call to 8284df9cb4SJed Brown TSCreate_GL() when using static libraries. 8384df9cb4SJed Brown 8484df9cb4SJed Brown Input Parameter: 8584df9cb4SJed Brown path - The dynamic library path, or PETSC_NULL 8684df9cb4SJed Brown 8784df9cb4SJed Brown Level: developer 8884df9cb4SJed Brown 8984df9cb4SJed Brown .keywords: TSAdapt, initialize, package 9084df9cb4SJed Brown .seealso: PetscInitialize() 9184df9cb4SJed Brown @*/ 9284df9cb4SJed Brown PetscErrorCode TSAdaptInitializePackage(const char path[]) 9384df9cb4SJed Brown { 9484df9cb4SJed Brown PetscErrorCode ierr; 9584df9cb4SJed Brown 9684df9cb4SJed Brown PetscFunctionBegin; 9784df9cb4SJed Brown if (TSAdaptPackageInitialized) PetscFunctionReturn(0); 9884df9cb4SJed Brown TSAdaptPackageInitialized = PETSC_TRUE; 9984df9cb4SJed Brown ierr = PetscClassIdRegister("TSAdapt",&TSADAPT_CLASSID);CHKERRQ(ierr); 10084df9cb4SJed Brown ierr = TSAdaptRegisterAll(path);CHKERRQ(ierr); 10184df9cb4SJed Brown ierr = PetscRegisterFinalize(TSAdaptFinalizePackage);CHKERRQ(ierr); 10284df9cb4SJed Brown PetscFunctionReturn(0); 10384df9cb4SJed Brown } 10484df9cb4SJed Brown 10584df9cb4SJed Brown #undef __FUNCT__ 10684df9cb4SJed Brown #define __FUNCT__ "TSAdaptRegisterDestroy" 10784df9cb4SJed Brown /*@C 10884df9cb4SJed Brown TSAdaptRegisterDestroy - Frees the list of adaptivity schemes that were registered by TSAdaptRegister()/TSAdaptRegisterDynamic(). 10984df9cb4SJed Brown 11084df9cb4SJed Brown Not Collective 11184df9cb4SJed Brown 11284df9cb4SJed Brown Level: advanced 11384df9cb4SJed Brown 11484df9cb4SJed Brown .keywords: TSAdapt, register, destroy 11584df9cb4SJed Brown .seealso: TSAdaptRegister(), TSAdaptRegisterAll(), TSAdaptRegisterDynamic() 11684df9cb4SJed Brown @*/ 11784df9cb4SJed Brown PetscErrorCode TSAdaptRegisterDestroy(void) 11884df9cb4SJed Brown { 11984df9cb4SJed Brown PetscErrorCode ierr; 12084df9cb4SJed Brown 12184df9cb4SJed Brown PetscFunctionBegin; 12284df9cb4SJed Brown ierr = PetscFListDestroy(&TSAdaptList);CHKERRQ(ierr); 12384df9cb4SJed Brown TSAdaptRegisterAllCalled = PETSC_FALSE; 12484df9cb4SJed Brown PetscFunctionReturn(0); 12584df9cb4SJed Brown } 12684df9cb4SJed Brown 12784df9cb4SJed Brown 12884df9cb4SJed Brown #undef __FUNCT__ 12984df9cb4SJed Brown #define __FUNCT__ "TSAdaptSetType" 13084df9cb4SJed Brown PetscErrorCode TSAdaptSetType(TSAdapt adapt,const TSAdaptType type) 13184df9cb4SJed Brown { 13284df9cb4SJed Brown PetscErrorCode ierr,(*r)(TSAdapt); 13384df9cb4SJed Brown 13484df9cb4SJed Brown PetscFunctionBegin; 13584df9cb4SJed Brown ierr = PetscFListFind(TSAdaptList,((PetscObject)adapt)->comm,type,PETSC_TRUE,(void(**)(void))&r);CHKERRQ(ierr); 13684df9cb4SJed Brown if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown TSAdapt type \"%s\" given",type); 13784df9cb4SJed Brown if (((PetscObject)adapt)->type_name) {ierr = (*adapt->ops->destroy)(adapt);CHKERRQ(ierr);} 13884df9cb4SJed Brown ierr = (*r)(adapt);CHKERRQ(ierr); 13984df9cb4SJed Brown ierr = PetscObjectChangeTypeName((PetscObject)adapt,type);CHKERRQ(ierr); 14084df9cb4SJed Brown PetscFunctionReturn(0); 14184df9cb4SJed Brown } 14284df9cb4SJed Brown 14384df9cb4SJed Brown #undef __FUNCT__ 14484df9cb4SJed Brown #define __FUNCT__ "TSAdaptSetOptionsPrefix" 14584df9cb4SJed Brown PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt adapt,const char prefix[]) 14684df9cb4SJed Brown { 14784df9cb4SJed Brown PetscErrorCode ierr; 14884df9cb4SJed Brown 14984df9cb4SJed Brown PetscFunctionBegin; 15084df9cb4SJed Brown ierr = PetscObjectSetOptionsPrefix((PetscObject)adapt,prefix);CHKERRQ(ierr); 15184df9cb4SJed Brown PetscFunctionReturn(0); 15284df9cb4SJed Brown } 15384df9cb4SJed Brown 15484df9cb4SJed Brown #undef __FUNCT__ 15584df9cb4SJed Brown #define __FUNCT__ "TSAdaptView" 15684df9cb4SJed Brown PetscErrorCode TSAdaptView(TSAdapt adapt,PetscViewer viewer) 15784df9cb4SJed Brown { 15884df9cb4SJed Brown PetscErrorCode ierr; 15984df9cb4SJed Brown PetscBool iascii; 16084df9cb4SJed Brown 16184df9cb4SJed Brown PetscFunctionBegin; 16284df9cb4SJed Brown ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 16384df9cb4SJed Brown if (iascii) { 16484df9cb4SJed Brown ierr = PetscObjectPrintClassNamePrefixType((PetscObject)adapt,viewer,"TSAdapt Object");CHKERRQ(ierr); 16584df9cb4SJed Brown ierr = PetscViewerASCIIPrintf(viewer,"number of candidates %D\n",adapt->candidates.n);CHKERRQ(ierr); 16684df9cb4SJed Brown if (adapt->ops->view) { 16784df9cb4SJed Brown ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 16884df9cb4SJed Brown ierr = (*adapt->ops->view)(adapt,viewer);CHKERRQ(ierr); 16984df9cb4SJed Brown ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 17084df9cb4SJed Brown } 17184df9cb4SJed Brown } else { 17284df9cb4SJed Brown SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Viewer type %s not supported",((PetscObject)viewer)->type_name); 17384df9cb4SJed Brown } 17484df9cb4SJed Brown PetscFunctionReturn(0); 17584df9cb4SJed Brown } 17684df9cb4SJed Brown 17784df9cb4SJed Brown #undef __FUNCT__ 17884df9cb4SJed Brown #define __FUNCT__ "TSAdaptDestroy" 17984df9cb4SJed Brown PetscErrorCode TSAdaptDestroy(TSAdapt *adapt) 18084df9cb4SJed Brown { 18184df9cb4SJed Brown PetscErrorCode ierr; 18284df9cb4SJed Brown 18384df9cb4SJed Brown PetscFunctionBegin; 18484df9cb4SJed Brown if (!*adapt) PetscFunctionReturn(0); 18584df9cb4SJed Brown PetscValidHeaderSpecific(*adapt,TSADAPT_CLASSID,1); 18684df9cb4SJed Brown if (--((PetscObject)(*adapt))->refct > 0) {*adapt = 0; PetscFunctionReturn(0);} 18784df9cb4SJed Brown if ((*adapt)->ops->destroy) {ierr = (*(*adapt)->ops->destroy)(*adapt);CHKERRQ(ierr);} 1881c3436cfSJed Brown ierr = PetscViewerDestroy(&(*adapt)->monitor);CHKERRQ(ierr); 18984df9cb4SJed Brown ierr = PetscHeaderDestroy(adapt);CHKERRQ(ierr); 19084df9cb4SJed Brown PetscFunctionReturn(0); 19184df9cb4SJed Brown } 19284df9cb4SJed Brown 19384df9cb4SJed Brown #undef __FUNCT__ 1941c3436cfSJed Brown #define __FUNCT__ "TSAdaptSetMonitor" 1951c3436cfSJed Brown /*@ 1961c3436cfSJed Brown TSAdaptSetMonitor - Monitor the choices made by the adaptive controller 1971c3436cfSJed Brown 1981c3436cfSJed Brown Collective on TSAdapt 1991c3436cfSJed Brown 2001c3436cfSJed Brown Input Arguments: 2011c3436cfSJed Brown + adapt - adaptive controller context 2021c3436cfSJed Brown - flg - PETSC_TRUE to active a monitor, PETSC_FALSE to disable 2031c3436cfSJed Brown 2041c3436cfSJed Brown Level: intermediate 2051c3436cfSJed Brown 2061c3436cfSJed Brown .seealso: TSAdaptChoose() 2071c3436cfSJed Brown @*/ 2081c3436cfSJed Brown PetscErrorCode TSAdaptSetMonitor(TSAdapt adapt,PetscBool flg) 2091c3436cfSJed Brown { 2101c3436cfSJed Brown PetscErrorCode ierr; 2111c3436cfSJed Brown 2121c3436cfSJed Brown PetscFunctionBegin; 2131c3436cfSJed Brown if (flg) { 2141c3436cfSJed Brown if (!adapt->monitor) {ierr = PetscViewerASCIIOpen(((PetscObject)adapt)->comm,"stdout",&adapt->monitor);CHKERRQ(ierr);} 2151c3436cfSJed Brown } else { 2161c3436cfSJed Brown ierr = PetscViewerDestroy(&adapt->monitor);CHKERRQ(ierr); 2171c3436cfSJed Brown } 2181c3436cfSJed Brown PetscFunctionReturn(0); 2191c3436cfSJed Brown } 2201c3436cfSJed Brown 2211c3436cfSJed Brown #undef __FUNCT__ 2221c3436cfSJed Brown #define __FUNCT__ "TSAdaptSetStepLimits" 2231c3436cfSJed Brown /*@ 2241c3436cfSJed Brown TSAdaptSetStepLimits - Set minimum and maximum step sizes to be considered by the controller 2251c3436cfSJed Brown 2261c3436cfSJed Brown Logically Collective 2271c3436cfSJed Brown 2281c3436cfSJed Brown Input Arguments: 2291c3436cfSJed Brown + adapt - time step adaptivity context, usually gotten with TSGetAdapt() 2301c3436cfSJed Brown . hmin - minimum time step 2311c3436cfSJed Brown - hmax - maximum time step 2321c3436cfSJed Brown 2331c3436cfSJed Brown Options Database Keys: 2341c3436cfSJed Brown + -ts_adapt_dt_min - minimum time step 2351c3436cfSJed Brown - -ts_adapt_dt_max - maximum time step 2361c3436cfSJed Brown 2371c3436cfSJed Brown Level: intermediate 2381c3436cfSJed Brown 2391c3436cfSJed Brown .seealso: TSAdapt 2401c3436cfSJed Brown @*/ 2411c3436cfSJed Brown PetscErrorCode TSAdaptSetStepLimits(TSAdapt adapt,PetscReal hmin,PetscReal hmax) 2421c3436cfSJed Brown { 2431c3436cfSJed Brown 2441c3436cfSJed Brown PetscFunctionBegin; 2451c3436cfSJed Brown if (hmin != PETSC_DECIDE) adapt->dt_min = hmin; 2461c3436cfSJed Brown if (hmax != PETSC_DECIDE) adapt->dt_max = hmax; 2471c3436cfSJed Brown PetscFunctionReturn(0); 2481c3436cfSJed Brown } 2491c3436cfSJed Brown 2501c3436cfSJed Brown #undef __FUNCT__ 25184df9cb4SJed Brown #define __FUNCT__ "TSAdaptSetFromOptions" 25284df9cb4SJed Brown /*@ 25384df9cb4SJed Brown TSAdaptSetFromOptions - Sets various TSAdapt parameters from user options. 25484df9cb4SJed Brown 25584df9cb4SJed Brown Collective on TSAdapt 25684df9cb4SJed Brown 25784df9cb4SJed Brown Input Parameter: 25884df9cb4SJed Brown . adapt - the TSAdapt context 25984df9cb4SJed Brown 26084df9cb4SJed Brown Options Database Keys: 26184df9cb4SJed Brown . -ts_adapt_type <type> - basic 26284df9cb4SJed Brown 26384df9cb4SJed Brown Level: advanced 26484df9cb4SJed Brown 26584df9cb4SJed Brown Notes: 26684df9cb4SJed Brown This function is automatically called by TSSetFromOptions() 26784df9cb4SJed Brown 26884df9cb4SJed Brown .keywords: TS, TSGetAdapt(), TSAdaptSetType() 26984df9cb4SJed Brown 27084df9cb4SJed Brown .seealso: TSGetType() 27184df9cb4SJed Brown @*/ 27284df9cb4SJed Brown PetscErrorCode TSAdaptSetFromOptions(TSAdapt adapt) 27384df9cb4SJed Brown { 27484df9cb4SJed Brown PetscErrorCode ierr; 27584df9cb4SJed Brown char type[256] = TSADAPTBASIC; 2761c3436cfSJed Brown PetscBool set,flg; 27784df9cb4SJed Brown 27884df9cb4SJed Brown PetscFunctionBegin; 27984df9cb4SJed Brown /* This should use PetscOptionsBegin() if/when this becomes an object used outside of TS, but currently this 28084df9cb4SJed Brown * function can only be called from inside TSSetFromOptions_GL() */ 28184df9cb4SJed Brown ierr = PetscOptionsHead("TS Adaptivity options");CHKERRQ(ierr); 28284df9cb4SJed Brown ierr = PetscOptionsList("-ts_adapt_type","Algorithm to use for adaptivity","TSAdaptSetType",TSAdaptList, 28384df9cb4SJed Brown ((PetscObject)adapt)->type_name?((PetscObject)adapt)->type_name:type,type,sizeof type,&flg);CHKERRQ(ierr); 28484df9cb4SJed Brown if (flg || !((PetscObject)adapt)->type_name) { 28584df9cb4SJed Brown ierr = TSAdaptSetType(adapt,type);CHKERRQ(ierr); 28684df9cb4SJed Brown } 28784df9cb4SJed Brown if (adapt->ops->setfromoptions) {ierr = (*adapt->ops->setfromoptions)(adapt);CHKERRQ(ierr);} 2881c3436cfSJed Brown ierr = PetscOptionsReal("-ts_adapt_dt_min","Minimum time step considered","TSAdaptSetStepLimits",adapt->dt_min,&adapt->dt_min,PETSC_NULL);CHKERRQ(ierr); 2891c3436cfSJed Brown ierr = PetscOptionsReal("-ts_adapt_dt_max","Maximum time step considered","TSAdaptSetStepLimits",adapt->dt_max,&adapt->dt_max,PETSC_NULL);CHKERRQ(ierr); 29097335746SJed Brown ierr = PetscOptionsReal("-ts_adapt_scale_solve_failed","Scale step by this factor if solve fails","",adapt->scale_solve_failed,&adapt->scale_solve_failed,PETSC_NULL);CHKERRQ(ierr); 2911c3436cfSJed Brown ierr = PetscOptionsBool("-ts_adapt_monitor","Print choices made by adaptive controller","TSAdaptSetMonitor",adapt->monitor ? PETSC_TRUE : PETSC_FALSE,&flg,&set);CHKERRQ(ierr); 2921c3436cfSJed Brown if (set) {ierr = TSAdaptSetMonitor(adapt,flg);CHKERRQ(ierr);} 29384df9cb4SJed Brown ierr = PetscOptionsTail();CHKERRQ(ierr); 29484df9cb4SJed Brown PetscFunctionReturn(0); 29584df9cb4SJed Brown } 29684df9cb4SJed Brown 29784df9cb4SJed Brown #undef __FUNCT__ 29884df9cb4SJed Brown #define __FUNCT__ "TSAdaptCandidatesClear" 29984df9cb4SJed Brown /*@ 30084df9cb4SJed Brown TSAdaptCandidatesClear - clear any previously set candidate schemes 30184df9cb4SJed Brown 30284df9cb4SJed Brown Logically Collective 30384df9cb4SJed Brown 30484df9cb4SJed Brown Input Argument: 30584df9cb4SJed Brown . adapt - adaptive controller 30684df9cb4SJed Brown 30784df9cb4SJed Brown Level: developer 30884df9cb4SJed Brown 30984df9cb4SJed Brown .seealso: TSAdapt, TSAdaptCreate(), TSAdaptCandidateAdd(), TSAdaptChoose() 31084df9cb4SJed Brown @*/ 31184df9cb4SJed Brown PetscErrorCode TSAdaptCandidatesClear(TSAdapt adapt) 31284df9cb4SJed Brown { 31384df9cb4SJed Brown PetscErrorCode ierr; 31484df9cb4SJed Brown 31584df9cb4SJed Brown PetscFunctionBegin; 31684df9cb4SJed Brown ierr = PetscMemzero(&adapt->candidates,sizeof(adapt->candidates));CHKERRQ(ierr); 31784df9cb4SJed Brown PetscFunctionReturn(0); 31884df9cb4SJed Brown } 31984df9cb4SJed Brown 32084df9cb4SJed Brown #undef __FUNCT__ 32184df9cb4SJed Brown #define __FUNCT__ "TSAdaptCandidateAdd" 32284df9cb4SJed Brown /*@C 32384df9cb4SJed Brown TSAdaptCandidateAdd - add a candidate scheme for the adaptive controller to select from 32484df9cb4SJed Brown 32584df9cb4SJed Brown Logically Collective 32684df9cb4SJed Brown 32784df9cb4SJed Brown Input Arguments: 32884df9cb4SJed Brown + adapt - time step adaptivity context, obtained with TSGetAdapt() or TSAdaptCreate() 32984df9cb4SJed Brown . name - name of the candidate scheme to add 33084df9cb4SJed Brown . order - order of the candidate scheme 33184df9cb4SJed Brown . stageorder - stage order of the candidate scheme 3328d59e960SJed Brown . ccfl - stability coefficient relative to explicit Euler, used for CFL constraints 33384df9cb4SJed Brown . cost - relative measure of the amount of work required for the candidate scheme 33484df9cb4SJed Brown - inuse - indicates that this scheme is the one currently in use, this flag can only be set for one scheme 33584df9cb4SJed Brown 33684df9cb4SJed Brown Note: 33784df9cb4SJed Brown This routine is not available in Fortran. 33884df9cb4SJed Brown 33984df9cb4SJed Brown Level: developer 34084df9cb4SJed Brown 34184df9cb4SJed Brown .seealso: TSAdaptCandidatesClear(), TSAdaptChoose() 34284df9cb4SJed Brown @*/ 3438d59e960SJed Brown PetscErrorCode TSAdaptCandidateAdd(TSAdapt adapt,const char name[],PetscInt order,PetscInt stageorder,PetscReal ccfl,PetscReal cost,PetscBool inuse) 34484df9cb4SJed Brown { 34584df9cb4SJed Brown PetscInt c; 34684df9cb4SJed Brown 34784df9cb4SJed Brown PetscFunctionBegin; 34884df9cb4SJed Brown PetscValidHeaderSpecific(adapt,TSADAPT_CLASSID,1); 34984df9cb4SJed Brown if (order < 1) SETERRQ1(((PetscObject)adapt)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Classical order %D must be a positive integer",order); 35084df9cb4SJed Brown if (inuse) { 35184df9cb4SJed Brown if (adapt->candidates.inuse_set) SETERRQ(((PetscObject)adapt)->comm,PETSC_ERR_ARG_WRONGSTATE,"Cannot set the inuse method twice, maybe forgot to call TSAdaptCandidatesClear()"); 35284df9cb4SJed Brown adapt->candidates.inuse_set = PETSC_TRUE; 35384df9cb4SJed Brown } 3541c3436cfSJed Brown /* first slot if this is the current scheme, otherwise the next available slot */ 3551c3436cfSJed Brown c = inuse ? 0 : !adapt->candidates.inuse_set + adapt->candidates.n; 35684df9cb4SJed Brown adapt->candidates.name[c] = name; 35784df9cb4SJed Brown adapt->candidates.order[c] = order; 35884df9cb4SJed Brown adapt->candidates.stageorder[c] = stageorder; 3598d59e960SJed Brown adapt->candidates.ccfl[c] = ccfl; 36084df9cb4SJed Brown adapt->candidates.cost[c] = cost; 36184df9cb4SJed Brown adapt->candidates.n++; 36284df9cb4SJed Brown PetscFunctionReturn(0); 36384df9cb4SJed Brown } 36484df9cb4SJed Brown 36584df9cb4SJed Brown #undef __FUNCT__ 3668d59e960SJed Brown #define __FUNCT__ "TSAdaptCandidatesGet" 3678d59e960SJed Brown /*@C 3688d59e960SJed Brown TSAdaptCandidatesGet - Get the list of candidate orders of accuracy and cost 3698d59e960SJed Brown 3708d59e960SJed Brown Not Collective 3718d59e960SJed Brown 3728d59e960SJed Brown Input Arguments: 3738d59e960SJed Brown . adapt - time step adaptivity context 3748d59e960SJed Brown 3758d59e960SJed Brown Output Arguments: 3768d59e960SJed Brown + n - number of candidate schemes, always at least 1 3778d59e960SJed Brown . order - the order of each candidate scheme 3788d59e960SJed Brown . stageorder - the stage order of each candidate scheme 3798d59e960SJed Brown . ccfl - the CFL coefficient of each scheme 3808d59e960SJed Brown - cost - the relative cost of each scheme 3818d59e960SJed Brown 3828d59e960SJed Brown Level: developer 3838d59e960SJed Brown 3848d59e960SJed Brown Note: 3858d59e960SJed Brown The current scheme is always returned in the first slot 3868d59e960SJed Brown 3878d59e960SJed Brown .seealso: TSAdaptCandidatesClear(), TSAdaptCandidateAdd(), TSAdaptChoose() 3888d59e960SJed Brown @*/ 3898d59e960SJed Brown PetscErrorCode TSAdaptCandidatesGet(TSAdapt adapt,PetscInt *n,const PetscInt **order,const PetscInt **stageorder,const PetscReal **ccfl,const PetscReal **cost) 3908d59e960SJed Brown { 3918d59e960SJed Brown PetscFunctionBegin; 3928d59e960SJed Brown PetscValidHeaderSpecific(adapt,TSADAPT_CLASSID,1); 3938d59e960SJed Brown if (n) *n = adapt->candidates.n; 3948d59e960SJed Brown if (order) *order = adapt->candidates.order; 3958d59e960SJed Brown if (stageorder) *stageorder = adapt->candidates.stageorder; 3968d59e960SJed Brown if (ccfl) *ccfl = adapt->candidates.ccfl; 3978d59e960SJed Brown if (cost) *cost = adapt->candidates.cost; 3988d59e960SJed Brown PetscFunctionReturn(0); 3998d59e960SJed Brown } 4008d59e960SJed Brown 4018d59e960SJed Brown #undef __FUNCT__ 40284df9cb4SJed Brown #define __FUNCT__ "TSAdaptChoose" 40384df9cb4SJed Brown /*@C 40484df9cb4SJed Brown TSAdaptChoose - choose which method and step size to use for the next step 40584df9cb4SJed Brown 40684df9cb4SJed Brown Logically Collective 40784df9cb4SJed Brown 40884df9cb4SJed Brown Input Arguments: 40984df9cb4SJed Brown + adapt - adaptive contoller 41084df9cb4SJed Brown - h - current step size 41184df9cb4SJed Brown 41284df9cb4SJed Brown Output Arguments: 41384df9cb4SJed Brown + next_sc - scheme to use for the next step 41484df9cb4SJed Brown . next_h - step size to use for the next step 41584df9cb4SJed Brown - accept - PETSC_TRUE to accept the current step, PETSC_FALSE to repeat the current step with the new step size 41684df9cb4SJed Brown 4171c3436cfSJed Brown Note: 4181c3436cfSJed Brown The input value of parameter accept is retained from the last time step, so it will be PETSC_FALSE if the step is 4191c3436cfSJed Brown being retried after an initial rejection. 4201c3436cfSJed Brown 42184df9cb4SJed Brown Level: developer 42284df9cb4SJed Brown 42384df9cb4SJed Brown .seealso: TSAdapt, TSAdaptCandidatesClear(), TSAdaptCandidateAdd() 42484df9cb4SJed Brown @*/ 42584df9cb4SJed Brown PetscErrorCode TSAdaptChoose(TSAdapt adapt,TS ts,PetscReal h,PetscInt *next_sc,PetscReal *next_h,PetscBool *accept) 42684df9cb4SJed Brown { 42784df9cb4SJed Brown PetscErrorCode ierr; 4280b99f514SJed Brown PetscReal wlte = -1.0; 42984df9cb4SJed Brown 43084df9cb4SJed Brown PetscFunctionBegin; 43184df9cb4SJed Brown PetscValidHeaderSpecific(adapt,TSADAPT_CLASSID,1); 43284df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,2); 43384df9cb4SJed Brown PetscValidIntPointer(next_sc,4); 43484df9cb4SJed Brown PetscValidPointer(next_h,5); 43584df9cb4SJed Brown PetscValidIntPointer(accept,6); 43684df9cb4SJed Brown if (adapt->candidates.n < 1) SETERRQ1(((PetscObject)adapt)->comm,PETSC_ERR_ARG_WRONGSTATE,"%D candidates have been registered",adapt->candidates.n); 43784df9cb4SJed Brown if (!adapt->candidates.inuse_set) SETERRQ1(((PetscObject)adapt)->comm,PETSC_ERR_ARG_WRONGSTATE,"The current in-use scheme is not among the %D candidates",adapt->candidates.n); 4380b99f514SJed Brown ierr = (*adapt->ops->choose)(adapt,ts,h,next_sc,next_h,accept,&wlte);CHKERRQ(ierr); 4391c3436cfSJed Brown if (*next_sc < 0 || adapt->candidates.n <= *next_sc) SETERRQ2(((PetscObject)adapt)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Chosen scheme %D not in valid range 0..%D",*next_sc,adapt->candidates.n-1); 4401c3436cfSJed Brown if (!(*next_h > 0.)) SETERRQ1(((PetscObject)adapt)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Computed step size %G must be positive",*next_h); 4411c3436cfSJed Brown 4421c3436cfSJed Brown if (adapt->monitor) { 4431c3436cfSJed Brown ierr = PetscViewerASCIIAddTab(adapt->monitor,((PetscObject)adapt)->tablevel);CHKERRQ(ierr); 4440b99f514SJed Brown if (wlte < 0) { 4450b99f514SJed Brown ierr = PetscViewerASCIIPrintf(adapt->monitor," TSAdapt '%s': step %3D %s t=%-11g+%10.3e family='%s' scheme=%D:'%s' dt=%-10g\n",((PetscObject)adapt)->type_name,ts->steps,*accept?"accepted":"rejected",(double)ts->ptime,h,((PetscObject)ts)->type_name,*next_sc,adapt->candidates.name[*next_sc],(double)*next_h);CHKERRQ(ierr); 4460b99f514SJed Brown } else { 4470b99f514SJed Brown ierr = PetscViewerASCIIPrintf(adapt->monitor," TSAdapt '%s': step %3D %s t=%-11g+%10.3e wlte=%5.3g family='%s' scheme=%D:'%s' dt=%-10.3e\n",((PetscObject)adapt)->type_name,ts->steps,*accept?"accepted":"rejected",(double)ts->ptime,h,(double)wlte,((PetscObject)ts)->type_name,*next_sc,adapt->candidates.name[*next_sc],(double)*next_h);CHKERRQ(ierr); 4480b99f514SJed Brown } 4491c3436cfSJed Brown ierr = PetscViewerASCIISubtractTab(adapt->monitor,((PetscObject)adapt)->tablevel);CHKERRQ(ierr); 4501c3436cfSJed Brown } 45184df9cb4SJed Brown PetscFunctionReturn(0); 45284df9cb4SJed Brown } 45384df9cb4SJed Brown 45484df9cb4SJed Brown #undef __FUNCT__ 45597335746SJed Brown #define __FUNCT__ "TSAdaptCheckStage" 45697335746SJed Brown /*@ 45797335746SJed Brown TSAdaptCheckStage - checks whether to accept a stage, (e.g. reject and change time step size if nonlinear solve fails) 45897335746SJed Brown 45997335746SJed Brown Collective 46097335746SJed Brown 46197335746SJed Brown Input Arguments: 46297335746SJed Brown + adapt - adaptive controller context 46397335746SJed Brown - ts - time stepper 46497335746SJed Brown 46597335746SJed Brown Output Arguments: 46697335746SJed Brown . accept - PETSC_TRUE to accept the stage, PETSC_FALSE to reject 46797335746SJed Brown 46897335746SJed Brown Level: developer 46997335746SJed Brown 47097335746SJed Brown .seealso: 47197335746SJed Brown @*/ 47297335746SJed Brown PetscErrorCode TSAdaptCheckStage(TSAdapt adapt,TS ts,PetscBool *accept) 47397335746SJed Brown { 47497335746SJed Brown PetscErrorCode ierr; 47597335746SJed Brown SNES snes; 47697335746SJed Brown SNESConvergedReason snesreason; 47797335746SJed Brown 47897335746SJed Brown PetscFunctionBegin; 47997335746SJed Brown *accept = PETSC_TRUE; 48097335746SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 48197335746SJed Brown ierr = SNESGetConvergedReason(snes,&snesreason);CHKERRQ(ierr); 48297335746SJed Brown if (snesreason < 0) { 48397335746SJed Brown PetscReal dt,new_dt; 48497335746SJed Brown *accept = PETSC_FALSE; 48597335746SJed Brown ierr = TSGetTimeStep(ts,&dt);CHKERRQ(ierr); 48697335746SJed Brown if (ts->max_snes_failures > 0 && ++ts->num_snes_failures >= ts->max_snes_failures) { 48797335746SJed Brown ts->reason = TS_DIVERGED_NONLINEAR_SOLVE; 48897335746SJed Brown ierr = PetscInfo2(ts,"Step=%D, nonlinear solve solve failures %D greater than current TS allowed, stopping solve\n",ts->steps,ts->num_snes_failures);CHKERRQ(ierr); 48997335746SJed Brown if (adapt->monitor) { 49097335746SJed Brown ierr = PetscViewerASCIIAddTab(adapt->monitor,((PetscObject)adapt)->tablevel);CHKERRQ(ierr); 49197335746SJed Brown ierr = PetscViewerASCIIPrintf(adapt->monitor," TSAdapt '%s': step %3D stage rejected t=%-11g+%10.3e, %D failures exceeds current TS allowed\n",((PetscObject)adapt)->type_name,ts->steps,(double)ts->ptime,dt,ts->num_snes_failures);CHKERRQ(ierr); 49297335746SJed Brown ierr = PetscViewerASCIISubtractTab(adapt->monitor,((PetscObject)adapt)->tablevel);CHKERRQ(ierr); 49397335746SJed Brown } 49497335746SJed Brown } else { 49597335746SJed Brown new_dt = dt*adapt->scale_solve_failed; 49697335746SJed Brown ierr = TSSetTimeStep(ts,new_dt);CHKERRQ(ierr); 49797335746SJed Brown if (adapt->monitor) { 49897335746SJed Brown ierr = PetscViewerASCIIAddTab(adapt->monitor,((PetscObject)adapt)->tablevel);CHKERRQ(ierr); 49997335746SJed Brown ierr = PetscViewerASCIIPrintf(adapt->monitor," TSAdapt '%s': step %3D stage rejected t=%-11g+%10.3e retrying with dt=%-10.3e\n",((PetscObject)adapt)->type_name,ts->steps,(double)ts->ptime,(double)dt,(double)new_dt);CHKERRQ(ierr); 50097335746SJed Brown ierr = PetscViewerASCIISubtractTab(adapt->monitor,((PetscObject)adapt)->tablevel);CHKERRQ(ierr); 50197335746SJed Brown } 50297335746SJed Brown } 50397335746SJed Brown } 50497335746SJed Brown PetscFunctionReturn(0); 50597335746SJed Brown } 50697335746SJed Brown 50797335746SJed Brown #undef __FUNCT__ 50884df9cb4SJed Brown #define __FUNCT__ "TSAdaptCreate" 50984df9cb4SJed Brown /*@ 51084df9cb4SJed Brown TSAdaptCreate - create an adaptive controller context for time stepping 51184df9cb4SJed Brown 51284df9cb4SJed Brown Collective on MPI_Comm 51384df9cb4SJed Brown 51484df9cb4SJed Brown Input Parameter: 51584df9cb4SJed Brown . comm - The communicator 51684df9cb4SJed Brown 51784df9cb4SJed Brown Output Parameter: 51884df9cb4SJed Brown . adapt - new TSAdapt object 51984df9cb4SJed Brown 52084df9cb4SJed Brown Level: developer 52184df9cb4SJed Brown 52284df9cb4SJed Brown Notes: 52384df9cb4SJed Brown TSAdapt creation is handled by TS, so users should not need to call this function. 52484df9cb4SJed Brown 52584df9cb4SJed Brown .keywords: TSAdapt, create 52684df9cb4SJed Brown .seealso: TSGetAdapt(), TSAdaptSetType(), TSAdaptDestroy() 52784df9cb4SJed Brown @*/ 52884df9cb4SJed Brown PetscErrorCode TSAdaptCreate(MPI_Comm comm,TSAdapt *inadapt) 52984df9cb4SJed Brown { 53084df9cb4SJed Brown PetscErrorCode ierr; 53184df9cb4SJed Brown TSAdapt adapt; 53284df9cb4SJed Brown 53384df9cb4SJed Brown PetscFunctionBegin; 53484df9cb4SJed Brown *inadapt = 0; 53584df9cb4SJed Brown ierr = PetscHeaderCreate(adapt,_p_TSAdapt,struct _TSAdaptOps,TSADAPT_CLASSID,0,"TSAdapt","General Linear adaptivity","TS",comm,TSAdaptDestroy,TSAdaptView);CHKERRQ(ierr); 5361c3436cfSJed Brown 5371c3436cfSJed Brown adapt->dt_min = 1e-20; 5381c3436cfSJed Brown adapt->dt_max = 1e50; 53997335746SJed Brown adapt->scale_solve_failed = 0.25; 5401c3436cfSJed Brown 54184df9cb4SJed Brown *inadapt = adapt; 54284df9cb4SJed Brown PetscFunctionReturn(0); 54384df9cb4SJed Brown } 544