1e884886fSBarry Smith 2c6db04a5SJed Brown #include <private/matimpl.h> 3c6db04a5SJed Brown #include <../src/mat/impls/mffd/mffdimpl.h> /*I "petscmat.h" I*/ 4e884886fSBarry Smith 5b022a5c1SBarry Smith PetscFList MatMFFDList = 0; 6ace3abfcSBarry Smith PetscBool MatMFFDRegisterAllCalled = PETSC_FALSE; 7e884886fSBarry Smith 87087cfbeSBarry Smith PetscClassId MATMFFD_CLASSID; 9166c7f25SBarry Smith PetscLogEvent MATMFFD_Mult; 10e884886fSBarry Smith 11ace3abfcSBarry Smith static PetscBool MatMFFDPackageInitialized = PETSC_FALSE; 12b022a5c1SBarry Smith #undef __FUNCT__ 13b022a5c1SBarry Smith #define __FUNCT__ "MatMFFDFinalizePackage" 14b022a5c1SBarry Smith /*@C 152390153bSJed Brown MatMFFDFinalizePackage - This function destroys everything in the MatMFFD package. It is 16b022a5c1SBarry Smith called from PetscFinalize(). 17b022a5c1SBarry Smith 18b022a5c1SBarry Smith Level: developer 19b022a5c1SBarry Smith 202390153bSJed Brown .keywords: Petsc, destroy, package 21b022a5c1SBarry Smith .seealso: PetscFinalize() 22b022a5c1SBarry Smith @*/ 237087cfbeSBarry Smith PetscErrorCode MatMFFDFinalizePackage(void) 24b022a5c1SBarry Smith { 25b022a5c1SBarry Smith PetscFunctionBegin; 26b022a5c1SBarry Smith MatMFFDPackageInitialized = PETSC_FALSE; 27b022a5c1SBarry Smith MatMFFDRegisterAllCalled = PETSC_FALSE; 28b022a5c1SBarry Smith MatMFFDList = PETSC_NULL; 29b022a5c1SBarry Smith PetscFunctionReturn(0); 30b022a5c1SBarry Smith } 31b022a5c1SBarry Smith 32e884886fSBarry Smith #undef __FUNCT__ 333ec795f1SBarry Smith #define __FUNCT__ "MatMFFDInitializePackage" 343ec795f1SBarry Smith /*@C 353ec795f1SBarry Smith MatMFFDInitializePackage - This function initializes everything in the MatMFFD package. It is called 363ec795f1SBarry Smith from PetscDLLibraryRegister() when using dynamic libraries, and on the first call to MatCreate_MFFD() 373ec795f1SBarry Smith when using static libraries. 383ec795f1SBarry Smith 393ec795f1SBarry Smith Input Parameter: 403ec795f1SBarry Smith . path - The dynamic library path, or PETSC_NULL 413ec795f1SBarry Smith 423ec795f1SBarry Smith Level: developer 433ec795f1SBarry Smith 443ec795f1SBarry Smith .keywords: Vec, initialize, package 453ec795f1SBarry Smith .seealso: PetscInitialize() 463ec795f1SBarry Smith @*/ 477087cfbeSBarry Smith PetscErrorCode MatMFFDInitializePackage(const char path[]) 483ec795f1SBarry Smith { 493ec795f1SBarry Smith char logList[256]; 503ec795f1SBarry Smith char *className; 51ace3abfcSBarry Smith PetscBool opt; 523ec795f1SBarry Smith PetscErrorCode ierr; 533ec795f1SBarry Smith 543ec795f1SBarry Smith PetscFunctionBegin; 55b022a5c1SBarry Smith if (MatMFFDPackageInitialized) PetscFunctionReturn(0); 56b022a5c1SBarry Smith MatMFFDPackageInitialized = PETSC_TRUE; 573ec795f1SBarry Smith /* Register Classes */ 580700a824SBarry Smith ierr = PetscClassIdRegister("MatMFFD",&MATMFFD_CLASSID);CHKERRQ(ierr); 593ec795f1SBarry Smith /* Register Constructors */ 603ec795f1SBarry Smith ierr = MatMFFDRegisterAll(path);CHKERRQ(ierr); 613ec795f1SBarry Smith /* Register Events */ 620700a824SBarry Smith ierr = PetscLogEventRegister("MatMult MF", MATMFFD_CLASSID,&MATMFFD_Mult);CHKERRQ(ierr); 633ec795f1SBarry Smith 643ec795f1SBarry Smith /* Process info exclusions */ 653ec795f1SBarry Smith ierr = PetscOptionsGetString(PETSC_NULL, "-info_exclude", logList, 256, &opt);CHKERRQ(ierr); 663ec795f1SBarry Smith if (opt) { 673ec795f1SBarry Smith ierr = PetscStrstr(logList, "matmffd", &className);CHKERRQ(ierr); 683ec795f1SBarry Smith if (className) { 690700a824SBarry Smith ierr = PetscInfoDeactivateClass(MATMFFD_CLASSID);CHKERRQ(ierr); 703ec795f1SBarry Smith } 713ec795f1SBarry Smith } 723ec795f1SBarry Smith /* Process summary exclusions */ 733ec795f1SBarry Smith ierr = PetscOptionsGetString(PETSC_NULL, "-log_summary_exclude", logList, 256, &opt);CHKERRQ(ierr); 743ec795f1SBarry Smith if (opt) { 753ec795f1SBarry Smith ierr = PetscStrstr(logList, "matmffd", &className);CHKERRQ(ierr); 763ec795f1SBarry Smith if (className) { 770700a824SBarry Smith ierr = PetscLogEventDeactivateClass(MATMFFD_CLASSID);CHKERRQ(ierr); 783ec795f1SBarry Smith } 793ec795f1SBarry Smith } 80b022a5c1SBarry Smith ierr = PetscRegisterFinalize(MatMFFDFinalizePackage);CHKERRQ(ierr); 813ec795f1SBarry Smith PetscFunctionReturn(0); 823ec795f1SBarry Smith } 833ec795f1SBarry Smith 843ec795f1SBarry Smith #undef __FUNCT__ 85e884886fSBarry Smith #define __FUNCT__ "MatMFFDSetType" 86e884886fSBarry Smith /*@C 87e884886fSBarry Smith MatMFFDSetType - Sets the method that is used to compute the 88e884886fSBarry Smith differencing parameter for finite differene matrix-free formulations. 89e884886fSBarry Smith 90e884886fSBarry Smith Input Parameters: 91e884886fSBarry Smith + mat - the "matrix-free" matrix created via MatCreateSNESMF(), or MatCreateMFFD() 92e884886fSBarry Smith or MatSetType(mat,MATMFFD); 93e884886fSBarry Smith - ftype - the type requested, either MATMFFD_WP or MATMFFD_DS 94e884886fSBarry Smith 95e884886fSBarry Smith Level: advanced 96e884886fSBarry Smith 97e884886fSBarry Smith Notes: 98e884886fSBarry Smith For example, such routines can compute h for use in 99e884886fSBarry Smith Jacobian-vector products of the form 100e884886fSBarry Smith 101e884886fSBarry Smith F(x+ha) - F(x) 102e884886fSBarry Smith F'(u)a ~= ---------------- 103e884886fSBarry Smith h 104e884886fSBarry Smith 105d2d6cebeSBarry Smith .seealso: MatCreateSNESMF(), MatMFFDRegisterDynamic(), MatMFFDSetFunction() 106e884886fSBarry Smith @*/ 1077087cfbeSBarry Smith PetscErrorCode MatMFFDSetType(Mat mat,const MatMFFDType ftype) 108e884886fSBarry Smith { 109e884886fSBarry Smith PetscErrorCode ierr,(*r)(MatMFFD); 110e884886fSBarry Smith MatMFFD ctx = (MatMFFD)mat->data; 111ace3abfcSBarry Smith PetscBool match; 112e884886fSBarry Smith 113e884886fSBarry Smith PetscFunctionBegin; 1140700a824SBarry Smith PetscValidHeaderSpecific(mat,MAT_CLASSID,1); 115e884886fSBarry Smith PetscValidCharPointer(ftype,2); 116e884886fSBarry Smith 1179a13eae7SJed Brown ierr = PetscTypeCompare((PetscObject)mat,MATMFFD,&match);CHKERRQ(ierr); 1189a13eae7SJed Brown if (!match) PetscFunctionReturn(0); 1199a13eae7SJed Brown 120e884886fSBarry Smith /* already set, so just return */ 121e884886fSBarry Smith ierr = PetscTypeCompare((PetscObject)ctx,ftype,&match);CHKERRQ(ierr); 122e884886fSBarry Smith if (match) PetscFunctionReturn(0); 123e884886fSBarry Smith 124e884886fSBarry Smith /* destroy the old one if it exists */ 125e884886fSBarry Smith if (ctx->ops->destroy) { 126e884886fSBarry Smith ierr = (*ctx->ops->destroy)(ctx);CHKERRQ(ierr); 127e884886fSBarry Smith } 128e884886fSBarry Smith 129b022a5c1SBarry Smith ierr = PetscFListFind(MatMFFDList,((PetscObject)ctx)->comm,ftype,(void (**)(void)) &r);CHKERRQ(ierr); 130e32f2f54SBarry Smith if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown MatMFFD type %s given",ftype); 131e884886fSBarry Smith ierr = (*r)(ctx);CHKERRQ(ierr); 132e884886fSBarry Smith ierr = PetscObjectChangeTypeName((PetscObject)ctx,ftype);CHKERRQ(ierr); 133e884886fSBarry Smith PetscFunctionReturn(0); 134e884886fSBarry Smith } 135e884886fSBarry Smith 136e884886fSBarry Smith typedef PetscErrorCode (*FCN1)(void*,Vec); /* force argument to next function to not be extern C*/ 137e884886fSBarry Smith EXTERN_C_BEGIN 138e884886fSBarry Smith #undef __FUNCT__ 139c879e56bSBarry Smith #define __FUNCT__ "MatMFFDSetFunctioniBase_MFFD" 1407087cfbeSBarry Smith PetscErrorCode MatMFFDSetFunctioniBase_MFFD(Mat mat,FCN1 func) 141e884886fSBarry Smith { 142e884886fSBarry Smith MatMFFD ctx = (MatMFFD)mat->data; 143e884886fSBarry Smith 144e884886fSBarry Smith PetscFunctionBegin; 145e884886fSBarry Smith ctx->funcisetbase = func; 146e884886fSBarry Smith PetscFunctionReturn(0); 147e884886fSBarry Smith } 148e884886fSBarry Smith EXTERN_C_END 149e884886fSBarry Smith 150e884886fSBarry Smith typedef PetscErrorCode (*FCN2)(void*,PetscInt,Vec,PetscScalar*); /* force argument to next function to not be extern C*/ 151e884886fSBarry Smith EXTERN_C_BEGIN 152e884886fSBarry Smith #undef __FUNCT__ 153c879e56bSBarry Smith #define __FUNCT__ "MatMFFDSetFunctioni_MFFD" 1547087cfbeSBarry Smith PetscErrorCode MatMFFDSetFunctioni_MFFD(Mat mat,FCN2 funci) 155e884886fSBarry Smith { 156e884886fSBarry Smith MatMFFD ctx = (MatMFFD)mat->data; 157e884886fSBarry Smith 158e884886fSBarry Smith PetscFunctionBegin; 159e884886fSBarry Smith ctx->funci = funci; 160e884886fSBarry Smith PetscFunctionReturn(0); 161e884886fSBarry Smith } 162e884886fSBarry Smith EXTERN_C_END 163e884886fSBarry Smith 164e884886fSBarry Smith 165e884886fSBarry Smith #undef __FUNCT__ 166e884886fSBarry Smith #define __FUNCT__ "MatMFFDRegister" 1677087cfbeSBarry Smith PetscErrorCode MatMFFDRegister(const char sname[],const char path[],const char name[],PetscErrorCode (*function)(MatMFFD)) 168e884886fSBarry Smith { 169e884886fSBarry Smith PetscErrorCode ierr; 170e884886fSBarry Smith char fullname[PETSC_MAX_PATH_LEN]; 171e884886fSBarry Smith 172e884886fSBarry Smith PetscFunctionBegin; 173e884886fSBarry Smith ierr = PetscFListConcat(path,name,fullname);CHKERRQ(ierr); 174b022a5c1SBarry Smith ierr = PetscFListAdd(&MatMFFDList,sname,fullname,(void (*)(void))function);CHKERRQ(ierr); 175e884886fSBarry Smith PetscFunctionReturn(0); 176e884886fSBarry Smith } 177e884886fSBarry Smith 178e884886fSBarry Smith 179e884886fSBarry Smith #undef __FUNCT__ 180e884886fSBarry Smith #define __FUNCT__ "MatMFFDRegisterDestroy" 181e884886fSBarry Smith /*@C 182e884886fSBarry Smith MatMFFDRegisterDestroy - Frees the list of MatMFFD methods that were 183e884886fSBarry Smith registered by MatMFFDRegisterDynamic). 184e884886fSBarry Smith 185e884886fSBarry Smith Not Collective 186e884886fSBarry Smith 187e884886fSBarry Smith Level: developer 188e884886fSBarry Smith 189e884886fSBarry Smith .keywords: MatMFFD, register, destroy 190e884886fSBarry Smith 191e884886fSBarry Smith .seealso: MatMFFDRegisterDynamic), MatMFFDRegisterAll() 192e884886fSBarry Smith @*/ 1937087cfbeSBarry Smith PetscErrorCode MatMFFDRegisterDestroy(void) 194e884886fSBarry Smith { 195e884886fSBarry Smith PetscErrorCode ierr; 196e884886fSBarry Smith 197e884886fSBarry Smith PetscFunctionBegin; 198b022a5c1SBarry Smith ierr = PetscFListDestroy(&MatMFFDList);CHKERRQ(ierr); 199e884886fSBarry Smith MatMFFDRegisterAllCalled = PETSC_FALSE; 200e884886fSBarry Smith PetscFunctionReturn(0); 201e884886fSBarry Smith } 202e884886fSBarry Smith 203e884886fSBarry Smith /* ----------------------------------------------------------------------------------------*/ 204e884886fSBarry Smith #undef __FUNCT__ 205e884886fSBarry Smith #define __FUNCT__ "MatDestroy_MFFD" 206e884886fSBarry Smith PetscErrorCode MatDestroy_MFFD(Mat mat) 207e884886fSBarry Smith { 208e884886fSBarry Smith PetscErrorCode ierr; 209e884886fSBarry Smith MatMFFD ctx = (MatMFFD)mat->data; 210e884886fSBarry Smith 211e884886fSBarry Smith PetscFunctionBegin; 212e884886fSBarry Smith if (ctx->w) { 213e884886fSBarry Smith ierr = VecDestroy(ctx->w);CHKERRQ(ierr); 214e884886fSBarry Smith } 215c3bb7e23SBarry Smith if (ctx->drscale) { 216c3bb7e23SBarry Smith ierr = VecDestroy(ctx->drscale);CHKERRQ(ierr); 217c3bb7e23SBarry Smith } 218c3bb7e23SBarry Smith if (ctx->dlscale) { 219c3bb7e23SBarry Smith ierr = VecDestroy(ctx->dlscale);CHKERRQ(ierr); 220c3bb7e23SBarry Smith } 221c3bb7e23SBarry Smith if (ctx->dshift) { 222c3bb7e23SBarry Smith ierr = VecDestroy(ctx->dshift);CHKERRQ(ierr); 223c3bb7e23SBarry Smith } 224cfe22f5eSBarry Smith if (ctx->current_f_allocated) { 225cfe22f5eSBarry Smith ierr = VecDestroy(ctx->current_f); 226cfe22f5eSBarry Smith } 227e884886fSBarry Smith if (ctx->ops->destroy) {ierr = (*ctx->ops->destroy)(ctx);CHKERRQ(ierr);} 228e884886fSBarry Smith if (ctx->sp) {ierr = MatNullSpaceDestroy(ctx->sp);CHKERRQ(ierr);} 229e884886fSBarry Smith ierr = PetscHeaderDestroy(ctx);CHKERRQ(ierr); 230e884886fSBarry Smith 231e884886fSBarry Smith ierr = PetscObjectComposeFunction((PetscObject)mat,"MatMFFDSetBase_C","",PETSC_NULL);CHKERRQ(ierr); 232e884886fSBarry Smith ierr = PetscObjectComposeFunction((PetscObject)mat,"MatMFFDSetFunctioniBase_C","",PETSC_NULL);CHKERRQ(ierr); 233e884886fSBarry Smith ierr = PetscObjectComposeFunction((PetscObject)mat,"MatMFFDSetFunctioni_C","",PETSC_NULL);CHKERRQ(ierr); 234e884886fSBarry Smith ierr = PetscObjectComposeFunction((PetscObject)mat,"MatMFFDSetCheckh_C","",PETSC_NULL);CHKERRQ(ierr); 235e884886fSBarry Smith 236e884886fSBarry Smith PetscFunctionReturn(0); 237e884886fSBarry Smith } 238e884886fSBarry Smith 239e884886fSBarry Smith #undef __FUNCT__ 240e884886fSBarry Smith #define __FUNCT__ "MatView_MFFD" 241e884886fSBarry Smith /* 242e884886fSBarry Smith MatMFFDView_MFFD - Views matrix-free parameters. 243e884886fSBarry Smith 244e884886fSBarry Smith */ 245e884886fSBarry Smith PetscErrorCode MatView_MFFD(Mat J,PetscViewer viewer) 246e884886fSBarry Smith { 247e884886fSBarry Smith PetscErrorCode ierr; 248e884886fSBarry Smith MatMFFD ctx = (MatMFFD)J->data; 249ace3abfcSBarry Smith PetscBool iascii; 250e884886fSBarry Smith 251e884886fSBarry Smith PetscFunctionBegin; 2522692d6eeSBarry Smith ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 253e884886fSBarry Smith if (iascii) { 254e884886fSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," matrix-free approximation:\n");CHKERRQ(ierr); 255e884886fSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," err=%G (relative error in function evaluation)\n",ctx->error_rel);CHKERRQ(ierr); 2567adad957SLisandro Dalcin if (!((PetscObject)ctx)->type_name) { 257e884886fSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," The compute h routine has not yet been set\n");CHKERRQ(ierr); 258e884886fSBarry Smith } else { 2597adad957SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer," Using %s compute h routine\n",((PetscObject)ctx)->type_name);CHKERRQ(ierr); 260e884886fSBarry Smith } 261e884886fSBarry Smith if (ctx->ops->view) { 262e884886fSBarry Smith ierr = (*ctx->ops->view)(ctx,viewer);CHKERRQ(ierr); 263e884886fSBarry Smith } 264e884886fSBarry Smith } else { 265e32f2f54SBarry Smith SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Viewer type %s not supported for matrix-free matrix",((PetscObject)viewer)->type_name); 266e884886fSBarry Smith } 267e884886fSBarry Smith PetscFunctionReturn(0); 268e884886fSBarry Smith } 269e884886fSBarry Smith 270e884886fSBarry Smith #undef __FUNCT__ 271e884886fSBarry Smith #define __FUNCT__ "MatAssemblyEnd_MFFD" 272e884886fSBarry Smith /* 273e884886fSBarry Smith MatAssemblyEnd_MFFD - Resets the ctx->ncurrenth to zero. This 274e884886fSBarry Smith allows the user to indicate the beginning of a new linear solve by calling 275e884886fSBarry Smith MatAssemblyXXX() on the matrix free matrix. This then allows the 2761d0fab5eSBarry Smith MatCreateMFFD_WP() to properly compute ||U|| only the first time 277e884886fSBarry Smith in the linear solver rather than every time. 278e884886fSBarry Smith */ 279e884886fSBarry Smith PetscErrorCode MatAssemblyEnd_MFFD(Mat J,MatAssemblyType mt) 280e884886fSBarry Smith { 281e884886fSBarry Smith PetscErrorCode ierr; 282e884886fSBarry Smith MatMFFD j = (MatMFFD)J->data; 283e884886fSBarry Smith 284e884886fSBarry Smith PetscFunctionBegin; 285e884886fSBarry Smith ierr = MatMFFDResetHHistory(J);CHKERRQ(ierr); 286e884886fSBarry Smith j->vshift = 0.0; 287e884886fSBarry Smith j->vscale = 1.0; 288e884886fSBarry Smith PetscFunctionReturn(0); 289e884886fSBarry Smith } 290e884886fSBarry Smith 291e884886fSBarry Smith #undef __FUNCT__ 292e884886fSBarry Smith #define __FUNCT__ "MatMult_MFFD" 293e884886fSBarry Smith /* 294e884886fSBarry Smith MatMult_MFFD - Default matrix-free form for Jacobian-vector product, y = F'(u)*a: 295e884886fSBarry Smith 296e884886fSBarry Smith y ~= (F(u + ha) - F(u))/h, 297e884886fSBarry Smith where F = nonlinear function, as set by SNESSetFunction() 298e884886fSBarry Smith u = current iterate 299e884886fSBarry Smith h = difference interval 300e884886fSBarry Smith */ 301e884886fSBarry Smith PetscErrorCode MatMult_MFFD(Mat mat,Vec a,Vec y) 302e884886fSBarry Smith { 303e884886fSBarry Smith MatMFFD ctx = (MatMFFD)mat->data; 304e884886fSBarry Smith PetscScalar h; 305e884886fSBarry Smith Vec w,U,F; 306e884886fSBarry Smith PetscErrorCode ierr; 307ace3abfcSBarry Smith PetscBool zeroa; 308e884886fSBarry Smith 309e884886fSBarry Smith PetscFunctionBegin; 31084da1bf7SJed Brown if (!ctx->current_u) SETERRQ(((PetscObject)mat)->comm,PETSC_ERR_ARG_WRONGSTATE,"MatMFFDSetBase() has not been called, this is often caused by forgetting to call \n\t\tMatAssemblyBegin/End on the first Mat in the SNES compute function"); 311e884886fSBarry Smith /* We log matrix-free matrix-vector products separately, so that we can 312e884886fSBarry Smith separate the performance monitoring from the cases that use conventional 313e884886fSBarry Smith storage. We may eventually modify event logging to associate events 314e884886fSBarry Smith with particular objects, hence alleviating the more general problem. */ 315e884886fSBarry Smith ierr = PetscLogEventBegin(MATMFFD_Mult,a,y,0,0);CHKERRQ(ierr); 316e884886fSBarry Smith 317e884886fSBarry Smith w = ctx->w; 318e884886fSBarry Smith U = ctx->current_u; 3193ec795f1SBarry Smith F = ctx->current_f; 320e884886fSBarry Smith /* 321e884886fSBarry Smith Compute differencing parameter 322e884886fSBarry Smith */ 323e884886fSBarry Smith if (!ctx->ops->compute) { 324e884886fSBarry Smith ierr = MatMFFDSetType(mat,MATMFFD_WP);CHKERRQ(ierr); 325e884886fSBarry Smith ierr = MatMFFDSetFromOptions(mat);CHKERRQ(ierr); 326e884886fSBarry Smith } 327e884886fSBarry Smith ierr = (*ctx->ops->compute)(ctx,U,a,&h,&zeroa);CHKERRQ(ierr); 328e884886fSBarry Smith if (zeroa) { 329e884886fSBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 330e884886fSBarry Smith PetscFunctionReturn(0); 331e884886fSBarry Smith } 332e884886fSBarry Smith 333e32f2f54SBarry Smith if (PetscIsInfOrNanScalar(h)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Computed Nan differencing parameter h"); 334e884886fSBarry Smith if (ctx->checkh) { 335e884886fSBarry Smith ierr = (*ctx->checkh)(ctx->checkhctx,U,a,&h);CHKERRQ(ierr); 336e884886fSBarry Smith } 337e884886fSBarry Smith 338e884886fSBarry Smith /* keep a record of the current differencing parameter h */ 339e884886fSBarry Smith ctx->currenth = h; 340e884886fSBarry Smith #if defined(PETSC_USE_COMPLEX) 341e884886fSBarry Smith ierr = PetscInfo2(mat,"Current differencing parameter: %G + %G i\n",PetscRealPart(h),PetscImaginaryPart(h));CHKERRQ(ierr); 342e884886fSBarry Smith #else 343e884886fSBarry Smith ierr = PetscInfo1(mat,"Current differencing parameter: %15.12e\n",h);CHKERRQ(ierr); 344e884886fSBarry Smith #endif 345e884886fSBarry Smith if (ctx->historyh && ctx->ncurrenth < ctx->maxcurrenth) { 346e884886fSBarry Smith ctx->historyh[ctx->ncurrenth] = h; 347e884886fSBarry Smith } 348e884886fSBarry Smith ctx->ncurrenth++; 349e884886fSBarry Smith 350e884886fSBarry Smith /* w = u + ha */ 351c3bb7e23SBarry Smith if (ctx->drscale) { 352c3bb7e23SBarry Smith ierr = VecPointwiseMult(ctx->drscale,a,U);CHKERRQ(ierr); 353c3bb7e23SBarry Smith ierr = VecAYPX(U,h,w);CHKERRQ(ierr); 354c3bb7e23SBarry Smith } else { 355e884886fSBarry Smith ierr = VecWAXPY(w,h,a,U);CHKERRQ(ierr); 356c3bb7e23SBarry Smith } 357e884886fSBarry Smith 358bcddec3dSBarry Smith /* compute func(U) as base for differencing; only needed first time in and not when provided by user */ 359bcddec3dSBarry Smith if (ctx->ncurrenth == 1 && ctx->current_f_allocated) { 360e884886fSBarry Smith ierr = (*ctx->func)(ctx->funcctx,U,F);CHKERRQ(ierr); 36152121784SBarry Smith } 362e884886fSBarry Smith ierr = (*ctx->func)(ctx->funcctx,w,y);CHKERRQ(ierr); 363e884886fSBarry Smith 364e884886fSBarry Smith ierr = VecAXPY(y,-1.0,F);CHKERRQ(ierr); 365e884886fSBarry Smith ierr = VecScale(y,1.0/h);CHKERRQ(ierr); 366e884886fSBarry Smith 367c35ec66cSMatthew G Knepley if ((ctx->vshift != 0.0) || (ctx->vscale != 1.0)) { 368e884886fSBarry Smith ierr = VecAXPBY(y,ctx->vshift,ctx->vscale,a);CHKERRQ(ierr); 369c3bb7e23SBarry Smith } 370c3bb7e23SBarry Smith if (ctx->dlscale) { 371c3bb7e23SBarry Smith ierr = VecPointwiseMult(y,ctx->dlscale,y);CHKERRQ(ierr); 372c3bb7e23SBarry Smith } 373c3bb7e23SBarry Smith if (ctx->dshift) { 374c3bb7e23SBarry Smith ierr = VecPointwiseMult(ctx->dshift,a,U);CHKERRQ(ierr); 375c3bb7e23SBarry Smith ierr = VecAXPY(y,1.0,U);CHKERRQ(ierr); 376c3bb7e23SBarry Smith } 377e884886fSBarry Smith 378e884886fSBarry Smith if (ctx->sp) {ierr = MatNullSpaceRemove(ctx->sp,y,PETSC_NULL);CHKERRQ(ierr);} 379e884886fSBarry Smith 380e884886fSBarry Smith ierr = PetscLogEventEnd(MATMFFD_Mult,a,y,0,0);CHKERRQ(ierr); 381e884886fSBarry Smith PetscFunctionReturn(0); 382e884886fSBarry Smith } 383e884886fSBarry Smith 384e884886fSBarry Smith #undef __FUNCT__ 385e884886fSBarry Smith #define __FUNCT__ "MatGetDiagonal_MFFD" 386e884886fSBarry Smith /* 387e884886fSBarry Smith MatGetDiagonal_MFFD - Gets the diagonal for a matrix free matrix 388e884886fSBarry Smith 389e884886fSBarry Smith y ~= (F(u + ha) - F(u))/h, 390e884886fSBarry Smith where F = nonlinear function, as set by SNESSetFunction() 391e884886fSBarry Smith u = current iterate 392e884886fSBarry Smith h = difference interval 393e884886fSBarry Smith */ 394e884886fSBarry Smith PetscErrorCode MatGetDiagonal_MFFD(Mat mat,Vec a) 395e884886fSBarry Smith { 396e884886fSBarry Smith MatMFFD ctx = (MatMFFD)mat->data; 397e884886fSBarry Smith PetscScalar h,*aa,*ww,v; 398e884886fSBarry Smith PetscReal epsilon = PETSC_SQRT_MACHINE_EPSILON,umin = 100.0*PETSC_SQRT_MACHINE_EPSILON; 399e884886fSBarry Smith Vec w,U; 400e884886fSBarry Smith PetscErrorCode ierr; 401e884886fSBarry Smith PetscInt i,rstart,rend; 402e884886fSBarry Smith 403e884886fSBarry Smith PetscFunctionBegin; 404e7e72b3dSBarry Smith if (!ctx->funci) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Requires calling MatMFFDSetFunctioni() first"); 405e884886fSBarry Smith 406e884886fSBarry Smith w = ctx->w; 407e884886fSBarry Smith U = ctx->current_u; 408e884886fSBarry Smith ierr = (*ctx->func)(ctx->funcctx,U,a);CHKERRQ(ierr); 409e884886fSBarry Smith ierr = (*ctx->funcisetbase)(ctx->funcctx,U);CHKERRQ(ierr); 410e884886fSBarry Smith ierr = VecCopy(U,w);CHKERRQ(ierr); 411e884886fSBarry Smith 412e884886fSBarry Smith ierr = VecGetOwnershipRange(a,&rstart,&rend);CHKERRQ(ierr); 413e884886fSBarry Smith ierr = VecGetArray(a,&aa);CHKERRQ(ierr); 414e884886fSBarry Smith for (i=rstart; i<rend; i++) { 415e884886fSBarry Smith ierr = VecGetArray(w,&ww);CHKERRQ(ierr); 416e884886fSBarry Smith h = ww[i-rstart]; 417e884886fSBarry Smith if (h == 0.0) h = 1.0; 418e884886fSBarry Smith #if !defined(PETSC_USE_COMPLEX) 419e884886fSBarry Smith if (h < umin && h >= 0.0) h = umin; 420e884886fSBarry Smith else if (h < 0.0 && h > -umin) h = -umin; 421e884886fSBarry Smith #else 422e884886fSBarry Smith if (PetscAbsScalar(h) < umin && PetscRealPart(h) >= 0.0) h = umin; 423e884886fSBarry Smith else if (PetscRealPart(h) < 0.0 && PetscAbsScalar(h) < umin) h = -umin; 424e884886fSBarry Smith #endif 425e884886fSBarry Smith h *= epsilon; 426e884886fSBarry Smith 427e884886fSBarry Smith ww[i-rstart] += h; 428e884886fSBarry Smith ierr = VecRestoreArray(w,&ww);CHKERRQ(ierr); 429e884886fSBarry Smith ierr = (*ctx->funci)(ctx->funcctx,i,w,&v);CHKERRQ(ierr); 430e884886fSBarry Smith aa[i-rstart] = (v - aa[i-rstart])/h; 431e884886fSBarry Smith 432e884886fSBarry Smith /* possibly shift and scale result */ 433c35ec66cSMatthew G Knepley if ((ctx->vshift != 0.0) || (ctx->vscale != 1.0)) { 434e884886fSBarry Smith aa[i - rstart] = ctx->vshift + ctx->vscale*aa[i-rstart]; 435c3bb7e23SBarry Smith } 436e884886fSBarry Smith 437e884886fSBarry Smith ierr = VecGetArray(w,&ww);CHKERRQ(ierr); 438e884886fSBarry Smith ww[i-rstart] -= h; 439e884886fSBarry Smith ierr = VecRestoreArray(w,&ww);CHKERRQ(ierr); 440e884886fSBarry Smith } 441e884886fSBarry Smith ierr = VecRestoreArray(a,&aa);CHKERRQ(ierr); 442e884886fSBarry Smith PetscFunctionReturn(0); 443e884886fSBarry Smith } 444e884886fSBarry Smith 445e884886fSBarry Smith #undef __FUNCT__ 446c3bb7e23SBarry Smith #define __FUNCT__ "MatDiagonalScale_MFFD" 447c3bb7e23SBarry Smith PetscErrorCode MatDiagonalScale_MFFD(Mat mat,Vec ll,Vec rr) 448c3bb7e23SBarry Smith { 449c3bb7e23SBarry Smith MatMFFD aij = (MatMFFD)mat->data; 450c3bb7e23SBarry Smith PetscErrorCode ierr; 451c3bb7e23SBarry Smith 452c3bb7e23SBarry Smith PetscFunctionBegin; 453c3bb7e23SBarry Smith if (ll && !aij->dlscale) { 454c3bb7e23SBarry Smith ierr = VecDuplicate(ll,&aij->dlscale);CHKERRQ(ierr); 455c3bb7e23SBarry Smith } 456c3bb7e23SBarry Smith if (rr && !aij->drscale) { 457c3bb7e23SBarry Smith ierr = VecDuplicate(rr,&aij->drscale);CHKERRQ(ierr); 458c3bb7e23SBarry Smith } 459c3bb7e23SBarry Smith if (ll) { 460c3bb7e23SBarry Smith ierr = VecCopy(ll,aij->dlscale);CHKERRQ(ierr); 461c3bb7e23SBarry Smith } 462c3bb7e23SBarry Smith if (rr) { 463c3bb7e23SBarry Smith ierr = VecCopy(rr,aij->drscale);CHKERRQ(ierr); 464c3bb7e23SBarry Smith } 465c3bb7e23SBarry Smith PetscFunctionReturn(0); 466c3bb7e23SBarry Smith } 467c3bb7e23SBarry Smith 468c3bb7e23SBarry Smith #undef __FUNCT__ 469c3bb7e23SBarry Smith #define __FUNCT__ "MatDiagonalSet_MFFD" 470c3bb7e23SBarry Smith PetscErrorCode MatDiagonalSet_MFFD(Mat mat,Vec ll,InsertMode mode) 471c3bb7e23SBarry Smith { 472c3bb7e23SBarry Smith MatMFFD aij = (MatMFFD)mat->data; 473c3bb7e23SBarry Smith PetscErrorCode ierr; 474c3bb7e23SBarry Smith 475c3bb7e23SBarry Smith PetscFunctionBegin; 476c3bb7e23SBarry Smith if (mode == INSERT_VALUES) SETERRQ(((PetscObject)mat)->comm,PETSC_ERR_SUP,"No diagonal set with INSERT_VALUES"); 477c3bb7e23SBarry Smith if (!aij->dshift) { 478c3bb7e23SBarry Smith ierr = VecDuplicate(ll,&aij->dshift);CHKERRQ(ierr); 479c3bb7e23SBarry Smith } 480c3bb7e23SBarry Smith ierr = VecAXPY(aij->dshift,1.0,ll);CHKERRQ(ierr); 481c3bb7e23SBarry Smith PetscFunctionReturn(0); 482c3bb7e23SBarry Smith } 483c3bb7e23SBarry Smith 484c3bb7e23SBarry Smith #undef __FUNCT__ 485e884886fSBarry Smith #define __FUNCT__ "MatShift_MFFD" 486e884886fSBarry Smith PetscErrorCode MatShift_MFFD(Mat Y,PetscScalar a) 487e884886fSBarry Smith { 488e884886fSBarry Smith MatMFFD shell = (MatMFFD)Y->data; 489e884886fSBarry Smith PetscFunctionBegin; 490e884886fSBarry Smith shell->vshift += a; 491e884886fSBarry Smith PetscFunctionReturn(0); 492e884886fSBarry Smith } 493e884886fSBarry Smith 494e884886fSBarry Smith #undef __FUNCT__ 495e884886fSBarry Smith #define __FUNCT__ "MatScale_MFFD" 496e884886fSBarry Smith PetscErrorCode MatScale_MFFD(Mat Y,PetscScalar a) 497e884886fSBarry Smith { 498e884886fSBarry Smith MatMFFD shell = (MatMFFD)Y->data; 499e884886fSBarry Smith PetscFunctionBegin; 500e884886fSBarry Smith shell->vscale *= a; 501e884886fSBarry Smith PetscFunctionReturn(0); 502e884886fSBarry Smith } 503e884886fSBarry Smith 504e884886fSBarry Smith EXTERN_C_BEGIN 505e884886fSBarry Smith #undef __FUNCT__ 506c879e56bSBarry Smith #define __FUNCT__ "MatMFFDSetBase_MFFD" 5077087cfbeSBarry Smith PetscErrorCode MatMFFDSetBase_MFFD(Mat J,Vec U,Vec F) 508e884886fSBarry Smith { 509e884886fSBarry Smith PetscErrorCode ierr; 510e884886fSBarry Smith MatMFFD ctx = (MatMFFD)J->data; 511e884886fSBarry Smith 512e884886fSBarry Smith PetscFunctionBegin; 513e884886fSBarry Smith ierr = MatMFFDResetHHistory(J);CHKERRQ(ierr); 514e884886fSBarry Smith ctx->current_u = U; 51552121784SBarry Smith if (F) { 516cfe22f5eSBarry Smith if (ctx->current_f_allocated) {ierr = VecDestroy(ctx->current_f);CHKERRQ(ierr);} 5173ec795f1SBarry Smith ctx->current_f = F; 518cfe22f5eSBarry Smith ctx->current_f_allocated = PETSC_FALSE; 519cfe22f5eSBarry Smith } else if (!ctx->current_f_allocated) { 52052121784SBarry Smith ierr = VecDuplicate(ctx->current_u, &ctx->current_f);CHKERRQ(ierr); 521cfe22f5eSBarry Smith ctx->current_f_allocated = PETSC_TRUE; 52252121784SBarry Smith } 523e884886fSBarry Smith if (!ctx->w) { 524e884886fSBarry Smith ierr = VecDuplicate(ctx->current_u, &ctx->w);CHKERRQ(ierr); 525e884886fSBarry Smith } 526e884886fSBarry Smith J->assembled = PETSC_TRUE; 527e884886fSBarry Smith PetscFunctionReturn(0); 528e884886fSBarry Smith } 529e884886fSBarry Smith EXTERN_C_END 530e884886fSBarry Smith typedef PetscErrorCode (*FCN3)(void*,Vec,Vec,PetscScalar*); /* force argument to next function to not be extern C*/ 531e884886fSBarry Smith EXTERN_C_BEGIN 532e884886fSBarry Smith #undef __FUNCT__ 533c879e56bSBarry Smith #define __FUNCT__ "MatMFFDSetCheckh_MFFD" 5347087cfbeSBarry Smith PetscErrorCode MatMFFDSetCheckh_MFFD(Mat J,FCN3 fun,void*ectx) 535e884886fSBarry Smith { 536e884886fSBarry Smith MatMFFD ctx = (MatMFFD)J->data; 537e884886fSBarry Smith 538e884886fSBarry Smith PetscFunctionBegin; 539e884886fSBarry Smith ctx->checkh = fun; 540e884886fSBarry Smith ctx->checkhctx = ectx; 541e884886fSBarry Smith PetscFunctionReturn(0); 542e884886fSBarry Smith } 543e884886fSBarry Smith EXTERN_C_END 544e884886fSBarry Smith 545e884886fSBarry Smith #undef __FUNCT__ 5466aa9148fSLisandro Dalcin #define __FUNCT__ "MatMFFDSetOptionsPrefix" 5476aa9148fSLisandro Dalcin /*@C 5486aa9148fSLisandro Dalcin MatMFFDSetOptionsPrefix - Sets the prefix used for searching for all 5496aa9148fSLisandro Dalcin MatMFFD options in the database. 5506aa9148fSLisandro Dalcin 5516aa9148fSLisandro Dalcin Collective on Mat 5526aa9148fSLisandro Dalcin 5536aa9148fSLisandro Dalcin Input Parameter: 5546aa9148fSLisandro Dalcin + A - the Mat context 5556aa9148fSLisandro Dalcin - prefix - the prefix to prepend to all option names 5566aa9148fSLisandro Dalcin 5576aa9148fSLisandro Dalcin Notes: 5586aa9148fSLisandro Dalcin A hyphen (-) must NOT be given at the beginning of the prefix name. 5596aa9148fSLisandro Dalcin The first character of all runtime options is AUTOMATICALLY the hyphen. 5606aa9148fSLisandro Dalcin 5616aa9148fSLisandro Dalcin Level: advanced 5626aa9148fSLisandro Dalcin 5636aa9148fSLisandro Dalcin .keywords: SNES, matrix-free, parameters 5646aa9148fSLisandro Dalcin 5656aa9148fSLisandro Dalcin .seealso: MatMFFDSetFromOptions(), MatCreateSNESMF() 5666aa9148fSLisandro Dalcin @*/ 5677087cfbeSBarry Smith PetscErrorCode MatMFFDSetOptionsPrefix(Mat mat,const char prefix[]) 5686aa9148fSLisandro Dalcin 5696aa9148fSLisandro Dalcin { 5706aa9148fSLisandro Dalcin MatMFFD mfctx = mat ? (MatMFFD)mat->data : PETSC_NULL; 5716aa9148fSLisandro Dalcin PetscErrorCode ierr; 5726aa9148fSLisandro Dalcin PetscFunctionBegin; 5730700a824SBarry Smith PetscValidHeaderSpecific(mat,MAT_CLASSID,1); 5740700a824SBarry Smith PetscValidHeaderSpecific(mfctx,MATMFFD_CLASSID,1); 5756aa9148fSLisandro Dalcin ierr = PetscObjectSetOptionsPrefix((PetscObject)mfctx,prefix);CHKERRQ(ierr); 5766aa9148fSLisandro Dalcin PetscFunctionReturn(0); 5776aa9148fSLisandro Dalcin } 5786aa9148fSLisandro Dalcin 5796aa9148fSLisandro Dalcin #undef __FUNCT__ 580e884886fSBarry Smith #define __FUNCT__ "MatMFFDSetFromOptions" 581e884886fSBarry Smith /*@ 582e884886fSBarry Smith MatMFFDSetFromOptions - Sets the MatMFFD options from the command line 583e884886fSBarry Smith parameter. 584e884886fSBarry Smith 585e884886fSBarry Smith Collective on Mat 586e884886fSBarry Smith 587e884886fSBarry Smith Input Parameters: 588e884886fSBarry Smith . mat - the matrix obtained with MatCreateMFFD() or MatCreateSNESMF() 589e884886fSBarry Smith 590e884886fSBarry Smith Options Database Keys: 591e884886fSBarry Smith + -mat_mffd_type - wp or ds (see MATMFFD_WP or MATMFFD_DS) 592e884886fSBarry Smith - -mat_mffd_err - square root of estimated relative error in function evaluation 593e884886fSBarry Smith - -mat_mffd_period - how often h is recomputed, defaults to 1, everytime 594e884886fSBarry Smith 595e884886fSBarry Smith Level: advanced 596e884886fSBarry Smith 597e884886fSBarry Smith .keywords: SNES, matrix-free, parameters 598e884886fSBarry Smith 5991d0fab5eSBarry Smith .seealso: MatCreateSNESMF(),MatMFFDSetHHistory(), MatMFFDResetHHistory() 600e884886fSBarry Smith @*/ 6017087cfbeSBarry Smith PetscErrorCode MatMFFDSetFromOptions(Mat mat) 602e884886fSBarry Smith { 60371f08665SBarry Smith MatMFFD mfctx = (MatMFFD)mat->data; 604e884886fSBarry Smith PetscErrorCode ierr; 605ace3abfcSBarry Smith PetscBool flg; 606e884886fSBarry Smith char ftype[256]; 607e884886fSBarry Smith 608e884886fSBarry Smith PetscFunctionBegin; 6090700a824SBarry Smith PetscValidHeaderSpecific(mat,MAT_CLASSID,1); 6100700a824SBarry Smith PetscValidHeaderSpecific(mfctx,MATMFFD_CLASSID,1); 6117adad957SLisandro Dalcin ierr = PetscOptionsBegin(((PetscObject)mfctx)->comm,((PetscObject)mfctx)->prefix,"Set matrix free computation parameters","MatMFFD");CHKERRQ(ierr); 612b022a5c1SBarry Smith ierr = PetscOptionsList("-mat_mffd_type","Matrix free type","MatMFFDSetType",MatMFFDList,((PetscObject)mfctx)->type_name,ftype,256,&flg);CHKERRQ(ierr); 613e884886fSBarry Smith if (flg) { 614e884886fSBarry Smith ierr = MatMFFDSetType(mat,ftype);CHKERRQ(ierr); 615e884886fSBarry Smith } 616e884886fSBarry Smith 617e884886fSBarry Smith ierr = PetscOptionsReal("-mat_mffd_err","set sqrt relative error in function","MatMFFDSetFunctionError",mfctx->error_rel,&mfctx->error_rel,0);CHKERRQ(ierr); 618e884886fSBarry Smith ierr = PetscOptionsInt("-mat_mffd_period","how often h is recomputed","MatMFFDSetPeriod",mfctx->recomputeperiod,&mfctx->recomputeperiod,0);CHKERRQ(ierr); 619e884886fSBarry Smith 62090d69ab7SBarry Smith flg = PETSC_FALSE; 621acfcf0e5SJed Brown ierr = PetscOptionsBool("-mat_mffd_check_positivity","Insure that U + h*a is nonnegative","MatMFFDSetCheckh",flg,&flg,PETSC_NULL);CHKERRQ(ierr); 622e884886fSBarry Smith if (flg) { 623e884886fSBarry Smith ierr = MatMFFDSetCheckh(mat,MatMFFDCheckPositivity,0);CHKERRQ(ierr); 624e884886fSBarry Smith } 625e884886fSBarry Smith if (mfctx->ops->setfromoptions) { 626e884886fSBarry Smith ierr = (*mfctx->ops->setfromoptions)(mfctx);CHKERRQ(ierr); 627e884886fSBarry Smith } 628e884886fSBarry Smith ierr = PetscOptionsEnd();CHKERRQ(ierr); 629e884886fSBarry Smith PetscFunctionReturn(0); 630e884886fSBarry Smith } 631e884886fSBarry Smith 632e884886fSBarry Smith /*MC 633e884886fSBarry Smith MATMFFD - MATMFFD = "mffd" - A matrix free matrix type. 634e884886fSBarry Smith 635e884886fSBarry Smith Level: advanced 636e884886fSBarry Smith 637d2d6cebeSBarry Smith .seealso: MatCreateMFFD(), MatCreateSNESMF(), MatMFFDSetFunction() 638e884886fSBarry Smith M*/ 639e884886fSBarry Smith EXTERN_C_BEGIN 640e884886fSBarry Smith #undef __FUNCT__ 641e884886fSBarry Smith #define __FUNCT__ "MatCreate_MFFD" 6427087cfbeSBarry Smith PetscErrorCode MatCreate_MFFD(Mat A) 643e884886fSBarry Smith { 644e884886fSBarry Smith MatMFFD mfctx; 645e884886fSBarry Smith PetscErrorCode ierr; 646e884886fSBarry Smith 647e884886fSBarry Smith PetscFunctionBegin; 6483ec795f1SBarry Smith #ifndef PETSC_USE_DYNAMIC_LIBRARIES 6493ec795f1SBarry Smith ierr = MatMFFDInitializePackage(PETSC_NULL);CHKERRQ(ierr); 6503ec795f1SBarry Smith #endif 651e884886fSBarry Smith 6520700a824SBarry Smith ierr = PetscHeaderCreate(mfctx,_p_MatMFFD,struct _MFOps,MATMFFD_CLASSID,0,"MatMFFD",((PetscObject)A)->comm,MatDestroy_MFFD,MatView_MFFD);CHKERRQ(ierr); 653e884886fSBarry Smith mfctx->sp = 0; 654e884886fSBarry Smith mfctx->error_rel = PETSC_SQRT_MACHINE_EPSILON; 655e884886fSBarry Smith mfctx->recomputeperiod = 1; 656e884886fSBarry Smith mfctx->count = 0; 657e884886fSBarry Smith mfctx->currenth = 0.0; 658e884886fSBarry Smith mfctx->historyh = PETSC_NULL; 659e884886fSBarry Smith mfctx->ncurrenth = 0; 660e884886fSBarry Smith mfctx->maxcurrenth = 0; 6617adad957SLisandro Dalcin ((PetscObject)mfctx)->type_name = 0; 662e884886fSBarry Smith 663e884886fSBarry Smith mfctx->vshift = 0.0; 664e884886fSBarry Smith mfctx->vscale = 1.0; 665e884886fSBarry Smith 666e884886fSBarry Smith /* 667e884886fSBarry Smith Create the empty data structure to contain compute-h routines. 668e884886fSBarry Smith These will be filled in below from the command line options or 669e884886fSBarry Smith a later call with MatMFFDSetType() or if that is not called 670e884886fSBarry Smith then it will default in the first use of MatMult_MFFD() 671e884886fSBarry Smith */ 672e884886fSBarry Smith mfctx->ops->compute = 0; 673e884886fSBarry Smith mfctx->ops->destroy = 0; 674e884886fSBarry Smith mfctx->ops->view = 0; 675e884886fSBarry Smith mfctx->ops->setfromoptions = 0; 676e884886fSBarry Smith mfctx->hctx = 0; 677e884886fSBarry Smith 678e884886fSBarry Smith mfctx->func = 0; 679e884886fSBarry Smith mfctx->funcctx = 0; 680e884886fSBarry Smith mfctx->w = PETSC_NULL; 681e884886fSBarry Smith 682e884886fSBarry Smith A->data = mfctx; 683e884886fSBarry Smith 684e884886fSBarry Smith A->ops->mult = MatMult_MFFD; 685e884886fSBarry Smith A->ops->destroy = MatDestroy_MFFD; 686e884886fSBarry Smith A->ops->view = MatView_MFFD; 687e884886fSBarry Smith A->ops->assemblyend = MatAssemblyEnd_MFFD; 688e884886fSBarry Smith A->ops->getdiagonal = MatGetDiagonal_MFFD; 689e884886fSBarry Smith A->ops->scale = MatScale_MFFD; 690e884886fSBarry Smith A->ops->shift = MatShift_MFFD; 691c3bb7e23SBarry Smith A->ops->diagonalscale = MatDiagonalScale_MFFD; 692c3bb7e23SBarry Smith A->ops->diagonalset = MatDiagonalSet_MFFD; 693e884886fSBarry Smith A->ops->setfromoptions = MatMFFDSetFromOptions; 694e884886fSBarry Smith A->assembled = PETSC_TRUE; 695e884886fSBarry Smith 69626283091SBarry Smith ierr = PetscLayoutSetBlockSize(A->rmap,1);CHKERRQ(ierr); 69726283091SBarry Smith ierr = PetscLayoutSetBlockSize(A->cmap,1);CHKERRQ(ierr); 69826283091SBarry Smith ierr = PetscLayoutSetUp(A->rmap);CHKERRQ(ierr); 69926283091SBarry Smith ierr = PetscLayoutSetUp(A->cmap);CHKERRQ(ierr); 700ee1cef2cSJed Brown 701c879e56bSBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)A,"MatMFFDSetBase_C","MatMFFDSetBase_MFFD",MatMFFDSetBase_MFFD);CHKERRQ(ierr); 702c879e56bSBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)A,"MatMFFDSetFunctioniBase_C","MatMFFDSetFunctioniBase_MFFD",MatMFFDSetFunctioniBase_MFFD);CHKERRQ(ierr); 703c879e56bSBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)A,"MatMFFDSetFunctioni_C","MatMFFDSetFunctioni_MFFD",MatMFFDSetFunctioni_MFFD);CHKERRQ(ierr); 704c879e56bSBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)A,"MatMFFDSetCheckh_C","MatMFFDSetCheckh_MFFD",MatMFFDSetCheckh_MFFD);CHKERRQ(ierr); 705e884886fSBarry Smith mfctx->mat = A; 706e884886fSBarry Smith ierr = PetscObjectChangeTypeName((PetscObject)A,MATMFFD);CHKERRQ(ierr); 707e884886fSBarry Smith PetscFunctionReturn(0); 708e884886fSBarry Smith } 709e884886fSBarry Smith EXTERN_C_END 710e884886fSBarry Smith 711e884886fSBarry Smith #undef __FUNCT__ 712e884886fSBarry Smith #define __FUNCT__ "MatCreateMFFD" 713e884886fSBarry Smith /*@ 714e884886fSBarry Smith MatCreateMFFD - Creates a matrix-free matrix. See also MatCreateSNESMF() 715e884886fSBarry Smith 716e884886fSBarry Smith Collective on Vec 717e884886fSBarry Smith 718e884886fSBarry Smith Input Parameters: 719fef1beadSBarry Smith + comm - MPI communicator 720fef1beadSBarry Smith . m - number of local rows (or PETSC_DECIDE to have calculated if M is given) 721fef1beadSBarry Smith This value should be the same as the local size used in creating the 722fef1beadSBarry Smith y vector for the matrix-vector product y = Ax. 723fef1beadSBarry Smith . n - This value should be the same as the local size used in creating the 724fef1beadSBarry Smith x vector for the matrix-vector product y = Ax. (or PETSC_DECIDE to have 725fef1beadSBarry Smith calculated if N is given) For square matrices n is almost always m. 726fef1beadSBarry Smith . M - number of global rows (or PETSC_DETERMINE to have calculated if m is given) 727fef1beadSBarry Smith - N - number of global columns (or PETSC_DETERMINE to have calculated if n is given) 728fef1beadSBarry Smith 729e884886fSBarry Smith 730e884886fSBarry Smith Output Parameter: 731e884886fSBarry Smith . J - the matrix-free matrix 732e884886fSBarry Smith 733e884886fSBarry Smith Level: advanced 734e884886fSBarry Smith 735e884886fSBarry Smith Notes: 736e884886fSBarry Smith The matrix-free matrix context merely contains the function pointers 737e884886fSBarry Smith and work space for performing finite difference approximations of 738e884886fSBarry Smith Jacobian-vector products, F'(u)*a, 739e884886fSBarry Smith 740e884886fSBarry Smith The default code uses the following approach to compute h 741e884886fSBarry Smith 742e884886fSBarry Smith .vb 743e884886fSBarry Smith F'(u)*a = [F(u+h*a) - F(u)]/h where 744e884886fSBarry Smith h = error_rel*u'a/||a||^2 if |u'a| > umin*||a||_{1} 745e884886fSBarry Smith = error_rel*umin*sign(u'a)*||a||_{1}/||a||^2 otherwise 746e884886fSBarry Smith where 747e884886fSBarry Smith error_rel = square root of relative error in function evaluation 748e884886fSBarry Smith umin = minimum iterate parameter 749e884886fSBarry Smith .ve 750e884886fSBarry Smith 751e884886fSBarry Smith The user can set the error_rel via MatMFFDSetFunctionError() and 7520598bfebSBarry Smith umin via MatMFFDDSSetUmin(); see the <A href="../../docs/manual.pdf#nameddest=ch_snes">SNES chapter of the users manual</A> for details. 753e884886fSBarry Smith 754e884886fSBarry Smith The user should call MatDestroy() when finished with the matrix-free 755e884886fSBarry Smith matrix context. 756e884886fSBarry Smith 757e884886fSBarry Smith Options Database Keys: 758e884886fSBarry Smith + -mat_mffd_err <error_rel> - Sets error_rel 759e884886fSBarry Smith . -mat_mffd_unim <umin> - Sets umin (for default PETSc routine that computes h only) 760e884886fSBarry Smith - -mat_mffd_check_positivity 761e884886fSBarry Smith 762e884886fSBarry Smith .keywords: default, matrix-free, create, matrix 763e884886fSBarry Smith 7641d0fab5eSBarry Smith .seealso: MatDestroy(), MatMFFDSetFunctionError(), MatMFFDDSSetUmin(), MatMFFDSetFunction() 765e884886fSBarry Smith MatMFFDSetHHistory(), MatMFFDResetHHistory(), MatCreateSNESMF(), 7661d0fab5eSBarry Smith MatMFFDGetH(), MatMFFDRegisterDynamic), MatMFFDComputeJacobian() 767e884886fSBarry Smith 768e884886fSBarry Smith @*/ 7697087cfbeSBarry Smith PetscErrorCode MatCreateMFFD(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *J) 770e884886fSBarry Smith { 771e884886fSBarry Smith PetscErrorCode ierr; 772e884886fSBarry Smith 773e884886fSBarry Smith PetscFunctionBegin; 774e884886fSBarry Smith ierr = MatCreate(comm,J);CHKERRQ(ierr); 775fef1beadSBarry Smith ierr = MatSetSizes(*J,m,n,M,N);CHKERRQ(ierr); 776e884886fSBarry Smith ierr = MatSetType(*J,MATMFFD);CHKERRQ(ierr); 777e884886fSBarry Smith PetscFunctionReturn(0); 778e884886fSBarry Smith } 779e884886fSBarry Smith 780e884886fSBarry Smith 781e884886fSBarry Smith #undef __FUNCT__ 782e884886fSBarry Smith #define __FUNCT__ "MatMFFDGetH" 783e884886fSBarry Smith /*@ 784e884886fSBarry Smith MatMFFDGetH - Gets the last value that was used as the differencing 785e884886fSBarry Smith parameter. 786e884886fSBarry Smith 787e884886fSBarry Smith Not Collective 788e884886fSBarry Smith 789e884886fSBarry Smith Input Parameters: 790e884886fSBarry Smith . mat - the matrix obtained with MatCreateSNESMF() 791e884886fSBarry Smith 792e884886fSBarry Smith Output Paramter: 793e884886fSBarry Smith . h - the differencing step size 794e884886fSBarry Smith 795e884886fSBarry Smith Level: advanced 796e884886fSBarry Smith 797e884886fSBarry Smith .keywords: SNES, matrix-free, parameters 798e884886fSBarry Smith 7991d0fab5eSBarry Smith .seealso: MatCreateSNESMF(),MatMFFDSetHHistory(), MatCreateMFFD(), MATMFFD, MatMFFDResetHHistory() 800e884886fSBarry Smith @*/ 8017087cfbeSBarry Smith PetscErrorCode MatMFFDGetH(Mat mat,PetscScalar *h) 802e884886fSBarry Smith { 803e884886fSBarry Smith MatMFFD ctx = (MatMFFD)mat->data; 804e884886fSBarry Smith 805e884886fSBarry Smith PetscFunctionBegin; 806e884886fSBarry Smith *h = ctx->currenth; 807e884886fSBarry Smith PetscFunctionReturn(0); 808e884886fSBarry Smith } 809e884886fSBarry Smith 810e884886fSBarry Smith 811e884886fSBarry Smith #undef __FUNCT__ 812e884886fSBarry Smith #define __FUNCT__ "MatMFFDSetFunction" 813e884886fSBarry Smith /*@C 814e884886fSBarry Smith MatMFFDSetFunction - Sets the function used in applying the matrix free. 815e884886fSBarry Smith 8163f9fe445SBarry Smith Logically Collective on Mat 817e884886fSBarry Smith 818e884886fSBarry Smith Input Parameters: 819e884886fSBarry Smith + mat - the matrix free matrix created via MatCreateSNESMF() 820e884886fSBarry Smith . func - the function to use 821e884886fSBarry Smith - funcctx - optional function context passed to function 822e884886fSBarry Smith 823e884886fSBarry Smith Level: advanced 824e884886fSBarry Smith 825e884886fSBarry Smith Notes: 826e884886fSBarry Smith If you use this you MUST call MatAssemblyBegin()/MatAssemblyEnd() on the matrix free 827e884886fSBarry Smith matrix inside your compute Jacobian routine 828e884886fSBarry Smith 8293ec795f1SBarry Smith If this is not set then it will use the function set with SNESSetFunction() if MatCreateSNESMF() was used. 830e884886fSBarry Smith 831e884886fSBarry Smith .keywords: SNES, matrix-free, function 832e884886fSBarry Smith 8331d0fab5eSBarry Smith .seealso: MatCreateSNESMF(),MatMFFDGetH(), MatCreateMFFD(), MATMFFD, 8341d0fab5eSBarry Smith MatMFFDSetHHistory(), MatMFFDResetHHistory(), SNESetFunction() 835e884886fSBarry Smith @*/ 8367087cfbeSBarry Smith PetscErrorCode MatMFFDSetFunction(Mat mat,PetscErrorCode (*func)(void*,Vec,Vec),void *funcctx) 837e884886fSBarry Smith { 838e884886fSBarry Smith MatMFFD ctx = (MatMFFD)mat->data; 839e884886fSBarry Smith 840e884886fSBarry Smith PetscFunctionBegin; 841e884886fSBarry Smith ctx->func = func; 842e884886fSBarry Smith ctx->funcctx = funcctx; 843e884886fSBarry Smith PetscFunctionReturn(0); 844e884886fSBarry Smith } 845e884886fSBarry Smith 846e884886fSBarry Smith #undef __FUNCT__ 847e884886fSBarry Smith #define __FUNCT__ "MatMFFDSetFunctioni" 848e884886fSBarry Smith /*@C 849e884886fSBarry Smith MatMFFDSetFunctioni - Sets the function for a single component 850e884886fSBarry Smith 8513f9fe445SBarry Smith Logically Collective on Mat 852e884886fSBarry Smith 853e884886fSBarry Smith Input Parameters: 854e884886fSBarry Smith + mat - the matrix free matrix created via MatCreateSNESMF() 855e884886fSBarry Smith - funci - the function to use 856e884886fSBarry Smith 857e884886fSBarry Smith Level: advanced 858e884886fSBarry Smith 859e884886fSBarry Smith Notes: 860e884886fSBarry Smith If you use this you MUST call MatAssemblyBegin()/MatAssemblyEnd() on the matrix free 861e884886fSBarry Smith matrix inside your compute Jacobian routine 862e884886fSBarry Smith 863e884886fSBarry Smith 864e884886fSBarry Smith .keywords: SNES, matrix-free, function 865e884886fSBarry Smith 8661d0fab5eSBarry Smith .seealso: MatCreateSNESMF(),MatMFFDGetH(), MatMFFDSetHHistory(), MatMFFDResetHHistory(), SNESetFunction() 8671d0fab5eSBarry Smith 868e884886fSBarry Smith @*/ 8697087cfbeSBarry Smith PetscErrorCode MatMFFDSetFunctioni(Mat mat,PetscErrorCode (*funci)(void*,PetscInt,Vec,PetscScalar*)) 870e884886fSBarry Smith { 8714ac538c5SBarry Smith PetscErrorCode ierr; 872e884886fSBarry Smith 873e884886fSBarry Smith PetscFunctionBegin; 8740700a824SBarry Smith PetscValidHeaderSpecific(mat,MAT_CLASSID,1); 8754ac538c5SBarry Smith ierr = PetscTryMethod(mat,"MatMFFDSetFunctioni_C",(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*)),(mat,funci));CHKERRQ(ierr); 876e884886fSBarry Smith PetscFunctionReturn(0); 877e884886fSBarry Smith } 878e884886fSBarry Smith 879e884886fSBarry Smith 880e884886fSBarry Smith #undef __FUNCT__ 881e884886fSBarry Smith #define __FUNCT__ "MatMFFDSetFunctioniBase" 882e884886fSBarry Smith /*@C 883e884886fSBarry Smith MatMFFDSetFunctioniBase - Sets the base vector for a single component function evaluation 884e884886fSBarry Smith 8853f9fe445SBarry Smith Logically Collective on Mat 886e884886fSBarry Smith 887e884886fSBarry Smith Input Parameters: 888e884886fSBarry Smith + mat - the matrix free matrix created via MatCreateSNESMF() 889e884886fSBarry Smith - func - the function to use 890e884886fSBarry Smith 891e884886fSBarry Smith Level: advanced 892e884886fSBarry Smith 893e884886fSBarry Smith Notes: 894e884886fSBarry Smith If you use this you MUST call MatAssemblyBegin()/MatAssemblyEnd() on the matrix free 895e884886fSBarry Smith matrix inside your compute Jacobian routine 896e884886fSBarry Smith 897e884886fSBarry Smith 898e884886fSBarry Smith .keywords: SNES, matrix-free, function 899e884886fSBarry Smith 900e884886fSBarry Smith .seealso: MatCreateSNESMF(),MatMFFDGetH(), MatCreateMFFD(), MATMFFD 9011d0fab5eSBarry Smith MatMFFDSetHHistory(), MatMFFDResetHHistory(), SNESetFunction() 902e884886fSBarry Smith @*/ 9037087cfbeSBarry Smith PetscErrorCode MatMFFDSetFunctioniBase(Mat mat,PetscErrorCode (*func)(void*,Vec)) 904e884886fSBarry Smith { 9054ac538c5SBarry Smith PetscErrorCode ierr; 906e884886fSBarry Smith 907e884886fSBarry Smith PetscFunctionBegin; 9080700a824SBarry Smith PetscValidHeaderSpecific(mat,MAT_CLASSID,1); 9094ac538c5SBarry Smith ierr = PetscTryMethod(mat,"MatMFFDSetFunctioniBase_C",(Mat,PetscErrorCode (*)(void*,Vec)),(mat,func));CHKERRQ(ierr); 910e884886fSBarry Smith PetscFunctionReturn(0); 911e884886fSBarry Smith } 912e884886fSBarry Smith 913e884886fSBarry Smith 914e884886fSBarry Smith #undef __FUNCT__ 915e884886fSBarry Smith #define __FUNCT__ "MatMFFDSetPeriod" 916e884886fSBarry Smith /*@ 917e884886fSBarry Smith MatMFFDSetPeriod - Sets how often h is recomputed, by default it is everytime 918e884886fSBarry Smith 9193f9fe445SBarry Smith Logically Collective on Mat 920e884886fSBarry Smith 921e884886fSBarry Smith Input Parameters: 922e884886fSBarry Smith + mat - the matrix free matrix created via MatCreateSNESMF() 923e884886fSBarry Smith - period - 1 for everytime, 2 for every second etc 924e884886fSBarry Smith 925e884886fSBarry Smith Options Database Keys: 926e884886fSBarry Smith + -mat_mffd_period <period> 927e884886fSBarry Smith 928e884886fSBarry Smith Level: advanced 929e884886fSBarry Smith 930e884886fSBarry Smith 931e884886fSBarry Smith .keywords: SNES, matrix-free, parameters 932e884886fSBarry Smith 933e884886fSBarry Smith .seealso: MatCreateSNESMF(),MatMFFDGetH(), 9341d0fab5eSBarry Smith MatMFFDSetHHistory(), MatMFFDResetHHistory() 935e884886fSBarry Smith @*/ 9367087cfbeSBarry Smith PetscErrorCode MatMFFDSetPeriod(Mat mat,PetscInt period) 937e884886fSBarry Smith { 938e884886fSBarry Smith MatMFFD ctx = (MatMFFD)mat->data; 939e884886fSBarry Smith 940e884886fSBarry Smith PetscFunctionBegin; 941c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(mat,period,2); 942e884886fSBarry Smith ctx->recomputeperiod = period; 943e884886fSBarry Smith PetscFunctionReturn(0); 944e884886fSBarry Smith } 945e884886fSBarry Smith 946e884886fSBarry Smith #undef __FUNCT__ 947e884886fSBarry Smith #define __FUNCT__ "MatMFFDSetFunctionError" 948e884886fSBarry Smith /*@ 949e884886fSBarry Smith MatMFFDSetFunctionError - Sets the error_rel for the approximation of 950e884886fSBarry Smith matrix-vector products using finite differences. 951e884886fSBarry Smith 9523f9fe445SBarry Smith Logically Collective on Mat 953e884886fSBarry Smith 954e884886fSBarry Smith Input Parameters: 955e884886fSBarry Smith + mat - the matrix free matrix created via MatCreateMFFD() or MatCreateSNESMF() 956e884886fSBarry Smith - error_rel - relative error (should be set to the square root of 957e884886fSBarry Smith the relative error in the function evaluations) 958e884886fSBarry Smith 959e884886fSBarry Smith Options Database Keys: 960e884886fSBarry Smith + -mat_mffd_err <error_rel> - Sets error_rel 961e884886fSBarry Smith 962e884886fSBarry Smith Level: advanced 963e884886fSBarry Smith 964e884886fSBarry Smith Notes: 965e884886fSBarry Smith The default matrix-free matrix-vector product routine computes 966e884886fSBarry Smith .vb 967e884886fSBarry Smith F'(u)*a = [F(u+h*a) - F(u)]/h where 968e884886fSBarry Smith h = error_rel*u'a/||a||^2 if |u'a| > umin*||a||_{1} 969e884886fSBarry Smith = error_rel*umin*sign(u'a)*||a||_{1}/||a||^2 else 970e884886fSBarry Smith .ve 971e884886fSBarry Smith 972e884886fSBarry Smith .keywords: SNES, matrix-free, parameters 973e884886fSBarry Smith 974e884886fSBarry Smith .seealso: MatCreateSNESMF(),MatMFFDGetH(), MatCreateMFFD(), MATMFFD 9751d0fab5eSBarry Smith MatMFFDSetHHistory(), MatMFFDResetHHistory() 976e884886fSBarry Smith @*/ 9777087cfbeSBarry Smith PetscErrorCode MatMFFDSetFunctionError(Mat mat,PetscReal error) 978e884886fSBarry Smith { 979e884886fSBarry Smith MatMFFD ctx = (MatMFFD)mat->data; 980e884886fSBarry Smith 981e884886fSBarry Smith PetscFunctionBegin; 982c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(mat,error,2); 983e884886fSBarry Smith if (error != PETSC_DEFAULT) ctx->error_rel = error; 984e884886fSBarry Smith PetscFunctionReturn(0); 985e884886fSBarry Smith } 986e884886fSBarry Smith 987e884886fSBarry Smith #undef __FUNCT__ 988e884886fSBarry Smith #define __FUNCT__ "MatMFFDAddNullSpace" 989e884886fSBarry Smith /*@ 990e884886fSBarry Smith MatMFFDAddNullSpace - Provides a null space that an operator is 991e884886fSBarry Smith supposed to have. Since roundoff will create a small component in 992e884886fSBarry Smith the null space, if you know the null space you may have it 993e884886fSBarry Smith automatically removed. 994e884886fSBarry Smith 9953f9fe445SBarry Smith Logically Collective on Mat 996e884886fSBarry Smith 997e884886fSBarry Smith Input Parameters: 998e884886fSBarry Smith + J - the matrix-free matrix context 999e884886fSBarry Smith - nullsp - object created with MatNullSpaceCreate() 1000e884886fSBarry Smith 1001e884886fSBarry Smith Level: advanced 1002e884886fSBarry Smith 1003e884886fSBarry Smith .keywords: SNES, matrix-free, null space 1004e884886fSBarry Smith 1005e884886fSBarry Smith .seealso: MatNullSpaceCreate(), MatMFFDGetH(), MatCreateSNESMF(), MatCreateMFFD(), MATMFFD 10061d0fab5eSBarry Smith MatMFFDSetHHistory(), MatMFFDResetHHistory() 1007e884886fSBarry Smith @*/ 10087087cfbeSBarry Smith PetscErrorCode MatMFFDAddNullSpace(Mat J,MatNullSpace nullsp) 1009e884886fSBarry Smith { 1010e884886fSBarry Smith PetscErrorCode ierr; 1011e884886fSBarry Smith MatMFFD ctx = (MatMFFD)J->data; 1012e884886fSBarry Smith 1013e884886fSBarry Smith PetscFunctionBegin; 1014e884886fSBarry Smith ierr = PetscObjectReference((PetscObject)nullsp);CHKERRQ(ierr); 1015e884886fSBarry Smith if (ctx->sp) { ierr = MatNullSpaceDestroy(ctx->sp);CHKERRQ(ierr); } 1016e884886fSBarry Smith ctx->sp = nullsp; 1017e884886fSBarry Smith PetscFunctionReturn(0); 1018e884886fSBarry Smith } 1019e884886fSBarry Smith 1020e884886fSBarry Smith #undef __FUNCT__ 1021e884886fSBarry Smith #define __FUNCT__ "MatMFFDSetHHistory" 1022e884886fSBarry Smith /*@ 1023e884886fSBarry Smith MatMFFDSetHHistory - Sets an array to collect a history of the 1024e884886fSBarry Smith differencing values (h) computed for the matrix-free product. 1025e884886fSBarry Smith 10263f9fe445SBarry Smith Logically Collective on Mat 1027e884886fSBarry Smith 1028e884886fSBarry Smith Input Parameters: 1029e884886fSBarry Smith + J - the matrix-free matrix context 1030e884886fSBarry Smith . histroy - space to hold the history 1031e884886fSBarry Smith - nhistory - number of entries in history, if more entries are generated than 1032e884886fSBarry Smith nhistory, then the later ones are discarded 1033e884886fSBarry Smith 1034e884886fSBarry Smith Level: advanced 1035e884886fSBarry Smith 1036e884886fSBarry Smith Notes: 1037e884886fSBarry Smith Use MatMFFDResetHHistory() to reset the history counter and collect 1038e884886fSBarry Smith a new batch of differencing parameters, h. 1039e884886fSBarry Smith 1040e884886fSBarry Smith .keywords: SNES, matrix-free, h history, differencing history 1041e884886fSBarry Smith 1042e884886fSBarry Smith .seealso: MatMFFDGetH(), MatCreateSNESMF(), 10431d0fab5eSBarry Smith MatMFFDResetHHistory(), MatMFFDSetFunctionError() 1044e884886fSBarry Smith 1045e884886fSBarry Smith @*/ 10467087cfbeSBarry Smith PetscErrorCode MatMFFDSetHHistory(Mat J,PetscScalar history[],PetscInt nhistory) 1047e884886fSBarry Smith { 1048e884886fSBarry Smith MatMFFD ctx = (MatMFFD)J->data; 1049e884886fSBarry Smith 1050e884886fSBarry Smith PetscFunctionBegin; 1051e884886fSBarry Smith ctx->historyh = history; 1052e884886fSBarry Smith ctx->maxcurrenth = nhistory; 105375567043SBarry Smith ctx->currenth = 0.; 1054e884886fSBarry Smith PetscFunctionReturn(0); 1055e884886fSBarry Smith } 1056e884886fSBarry Smith 1057e884886fSBarry Smith #undef __FUNCT__ 1058e884886fSBarry Smith #define __FUNCT__ "MatMFFDResetHHistory" 1059e884886fSBarry Smith /*@ 1060e884886fSBarry Smith MatMFFDResetHHistory - Resets the counter to zero to begin 1061e884886fSBarry Smith collecting a new set of differencing histories. 1062e884886fSBarry Smith 10633f9fe445SBarry Smith Logically Collective on Mat 1064e884886fSBarry Smith 1065e884886fSBarry Smith Input Parameters: 1066e884886fSBarry Smith . J - the matrix-free matrix context 1067e884886fSBarry Smith 1068e884886fSBarry Smith Level: advanced 1069e884886fSBarry Smith 1070e884886fSBarry Smith Notes: 1071e884886fSBarry Smith Use MatMFFDSetHHistory() to create the original history counter. 1072e884886fSBarry Smith 1073e884886fSBarry Smith .keywords: SNES, matrix-free, h history, differencing history 1074e884886fSBarry Smith 1075e884886fSBarry Smith .seealso: MatMFFDGetH(), MatCreateSNESMF(), 10761d0fab5eSBarry Smith MatMFFDSetHHistory(), MatMFFDSetFunctionError() 1077e884886fSBarry Smith 1078e884886fSBarry Smith @*/ 10797087cfbeSBarry Smith PetscErrorCode MatMFFDResetHHistory(Mat J) 1080e884886fSBarry Smith { 1081e884886fSBarry Smith MatMFFD ctx = (MatMFFD)J->data; 1082e884886fSBarry Smith 1083e884886fSBarry Smith PetscFunctionBegin; 1084e884886fSBarry Smith ctx->ncurrenth = 0; 1085e884886fSBarry Smith PetscFunctionReturn(0); 1086e884886fSBarry Smith } 1087e884886fSBarry Smith 1088e884886fSBarry Smith 1089e884886fSBarry Smith #undef __FUNCT__ 1090e884886fSBarry Smith #define __FUNCT__ "MatMFFDSetBase" 1091e884886fSBarry Smith /*@ 1092e884886fSBarry Smith MatMFFDSetBase - Sets the vector U at which matrix vector products of the 1093e884886fSBarry Smith Jacobian are computed 1094e884886fSBarry Smith 10953f9fe445SBarry Smith Logically Collective on Mat 1096e884886fSBarry Smith 1097e884886fSBarry Smith Input Parameters: 1098e884886fSBarry Smith + J - the MatMFFD matrix 10993ec795f1SBarry Smith . U - the vector 1100bcddec3dSBarry Smith - F - (optional) vector that contains F(u) if it has been already computed 1101e884886fSBarry Smith 1102e884886fSBarry Smith Notes: This is rarely used directly 1103e884886fSBarry Smith 11048af5ae88SBarry Smith If F is provided then it is not recomputed. Otherwise the function is evaluated at the base 11058af5ae88SBarry Smith point during the first MatMult() after each call to MatMFFDSetBase(). 1106dff2f722SBarry Smith 1107e884886fSBarry Smith Level: advanced 1108e884886fSBarry Smith 1109e884886fSBarry Smith @*/ 11107087cfbeSBarry Smith PetscErrorCode MatMFFDSetBase(Mat J,Vec U,Vec F) 1111e884886fSBarry Smith { 11124ac538c5SBarry Smith PetscErrorCode ierr; 1113e884886fSBarry Smith 1114e884886fSBarry Smith PetscFunctionBegin; 11150700a824SBarry Smith PetscValidHeaderSpecific(J,MAT_CLASSID,1); 11160700a824SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 11170700a824SBarry Smith if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,3); 11184ac538c5SBarry Smith ierr = PetscTryMethod(J,"MatMFFDSetBase_C",(Mat,Vec,Vec),(J,U,F));CHKERRQ(ierr); 1119e884886fSBarry Smith PetscFunctionReturn(0); 1120e884886fSBarry Smith } 1121e884886fSBarry Smith 1122e884886fSBarry Smith #undef __FUNCT__ 1123e884886fSBarry Smith #define __FUNCT__ "MatMFFDSetCheckh" 1124e884886fSBarry Smith /*@C 1125e884886fSBarry Smith MatMFFDSetCheckh - Sets a function that checks the computed h and adjusts 1126e884886fSBarry Smith it to satisfy some criteria 1127e884886fSBarry Smith 11283f9fe445SBarry Smith Logically Collective on Mat 1129e884886fSBarry Smith 1130e884886fSBarry Smith Input Parameters: 1131e884886fSBarry Smith + J - the MatMFFD matrix 1132e884886fSBarry Smith . fun - the function that checks h 1133e884886fSBarry Smith - ctx - any context needed by the function 1134e884886fSBarry Smith 1135e884886fSBarry Smith Options Database Keys: 1136e884886fSBarry Smith . -mat_mffd_check_positivity 1137e884886fSBarry Smith 1138e884886fSBarry Smith Level: advanced 1139e884886fSBarry Smith 1140e884886fSBarry Smith Notes: For example, MatMFFDSetCheckPositivity() insures that all entries 1141e884886fSBarry Smith of U + h*a are non-negative 1142e884886fSBarry Smith 1143e884886fSBarry Smith .seealso: MatMFFDSetCheckPositivity() 1144e884886fSBarry Smith @*/ 11457087cfbeSBarry Smith PetscErrorCode MatMFFDSetCheckh(Mat J,PetscErrorCode (*fun)(void*,Vec,Vec,PetscScalar*),void* ctx) 1146e884886fSBarry Smith { 11474ac538c5SBarry Smith PetscErrorCode ierr; 1148e884886fSBarry Smith 1149e884886fSBarry Smith PetscFunctionBegin; 11500700a824SBarry Smith PetscValidHeaderSpecific(J,MAT_CLASSID,1); 11514ac538c5SBarry Smith ierr = PetscTryMethod(J,"MatMFFDSetCheckh_C",(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*),(J,fun,ctx));CHKERRQ(ierr); 1152e884886fSBarry Smith PetscFunctionReturn(0); 1153e884886fSBarry Smith } 1154e884886fSBarry Smith 1155e884886fSBarry Smith #undef __FUNCT__ 1156e884886fSBarry Smith #define __FUNCT__ "MatMFFDSetCheckPositivity" 1157e884886fSBarry Smith /*@ 1158e884886fSBarry Smith MatMFFDCheckPositivity - Checks that all entries in U + h*a are positive or 1159e884886fSBarry Smith zero, decreases h until this is satisfied. 1160e884886fSBarry Smith 11613f9fe445SBarry Smith Logically Collective on Vec 1162e884886fSBarry Smith 1163e884886fSBarry Smith Input Parameters: 1164e884886fSBarry Smith + U - base vector that is added to 1165e884886fSBarry Smith . a - vector that is added 1166e884886fSBarry Smith . h - scaling factor on a 1167e884886fSBarry Smith - dummy - context variable (unused) 1168e884886fSBarry Smith 1169e884886fSBarry Smith Options Database Keys: 1170e884886fSBarry Smith . -mat_mffd_check_positivity 1171e884886fSBarry Smith 1172e884886fSBarry Smith Level: advanced 1173e884886fSBarry Smith 1174e884886fSBarry Smith Notes: This is rarely used directly, rather it is passed as an argument to 1175e884886fSBarry Smith MatMFFDSetCheckh() 1176e884886fSBarry Smith 1177e884886fSBarry Smith .seealso: MatMFFDSetCheckh() 1178e884886fSBarry Smith @*/ 11797087cfbeSBarry Smith PetscErrorCode MatMFFDCheckPositivity(void* dummy,Vec U,Vec a,PetscScalar *h) 1180e884886fSBarry Smith { 1181e884886fSBarry Smith PetscReal val, minval; 1182e884886fSBarry Smith PetscScalar *u_vec, *a_vec; 1183e884886fSBarry Smith PetscErrorCode ierr; 1184e884886fSBarry Smith PetscInt i,n; 1185e884886fSBarry Smith MPI_Comm comm; 1186e884886fSBarry Smith 1187e884886fSBarry Smith PetscFunctionBegin; 1188e884886fSBarry Smith ierr = PetscObjectGetComm((PetscObject)U,&comm);CHKERRQ(ierr); 1189e884886fSBarry Smith ierr = VecGetArray(U,&u_vec);CHKERRQ(ierr); 1190e884886fSBarry Smith ierr = VecGetArray(a,&a_vec);CHKERRQ(ierr); 1191e884886fSBarry Smith ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 1192e884886fSBarry Smith minval = PetscAbsScalar(*h*1.01); 1193e884886fSBarry Smith for(i=0;i<n;i++) { 1194e884886fSBarry Smith if (PetscRealPart(u_vec[i] + *h*a_vec[i]) <= 0.0) { 1195e884886fSBarry Smith val = PetscAbsScalar(u_vec[i]/a_vec[i]); 1196e884886fSBarry Smith if (val < minval) minval = val; 1197e884886fSBarry Smith } 1198e884886fSBarry Smith } 1199e884886fSBarry Smith ierr = VecRestoreArray(U,&u_vec);CHKERRQ(ierr); 1200e884886fSBarry Smith ierr = VecRestoreArray(a,&a_vec);CHKERRQ(ierr); 1201*d9822059SBarry Smith ierr = MPI_Allreduce(&minval,&val,1,MPIU_REAL,MPIU_MIN,comm);CHKERRQ(ierr); 1202e884886fSBarry Smith if (val <= PetscAbsScalar(*h)) { 1203e884886fSBarry Smith ierr = PetscInfo2(U,"Scaling back h from %G to %G\n",PetscRealPart(*h),.99*val);CHKERRQ(ierr); 1204e884886fSBarry Smith if (PetscRealPart(*h) > 0.0) *h = 0.99*val; 1205e884886fSBarry Smith else *h = -0.99*val; 1206e884886fSBarry Smith } 1207e884886fSBarry Smith PetscFunctionReturn(0); 1208e884886fSBarry Smith } 1209e884886fSBarry Smith 1210e884886fSBarry Smith 1211e884886fSBarry Smith 1212e884886fSBarry Smith 1213e884886fSBarry Smith 1214e884886fSBarry Smith 1215e884886fSBarry Smith 1216