| Line | Branch | Exec | Source |
|---|---|---|---|
| 1 | /* | ||
| 2 | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | ||
| 3 | SLEPc - Scalable Library for Eigenvalue Problem Computations | ||
| 4 | Copyright (c) 2002-, Universitat Politecnica de Valencia, Spain | ||
| 5 | |||
| 6 | This file is part of SLEPc. | ||
| 7 | SLEPc is distributed under a 2-clause BSD license (see LICENSE). | ||
| 8 | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | ||
| 9 | */ | ||
| 10 | /* | ||
| 11 | Basic MFN routines | ||
| 12 | */ | ||
| 13 | |||
| 14 | #include <slepc/private/mfnimpl.h> /*I "slepcmfn.h" I*/ | ||
| 15 | |||
| 16 | /* Logging support */ | ||
| 17 | PetscClassId MFN_CLASSID = 0; | ||
| 18 | PetscLogEvent MFN_SetUp = 0,MFN_Solve = 0; | ||
| 19 | |||
| 20 | /* List of registered MFN routines */ | ||
| 21 | PetscFunctionList MFNList = NULL; | ||
| 22 | PetscBool MFNRegisterAllCalled = PETSC_FALSE; | ||
| 23 | |||
| 24 | /* List of registered MFN monitors */ | ||
| 25 | PetscFunctionList MFNMonitorList = NULL; | ||
| 26 | PetscFunctionList MFNMonitorCreateList = NULL; | ||
| 27 | PetscFunctionList MFNMonitorDestroyList = NULL; | ||
| 28 | PetscBool MFNMonitorRegisterAllCalled = PETSC_FALSE; | ||
| 29 | |||
| 30 | /*@ | ||
| 31 | MFNView - Prints the `MFN` data structure. | ||
| 32 | |||
| 33 | Collective | ||
| 34 | |||
| 35 | Input Parameters: | ||
| 36 | + mfn - the matrix function solver context | ||
| 37 | - viewer - optional visualization context | ||
| 38 | |||
| 39 | Options Database Key: | ||
| 40 | . -mfn_view - calls `MFNView()` at end of `MFNSolve()` | ||
| 41 | |||
| 42 | Notes: | ||
| 43 | The available visualization contexts include | ||
| 44 | + `PETSC_VIEWER_STDOUT_SELF` - standard output (default) | ||
| 45 | - `PETSC_VIEWER_STDOUT_WORLD` - synchronized standard output where only the | ||
| 46 | first process opens the file; all other processes send their data to the | ||
| 47 | first one to print | ||
| 48 | |||
| 49 | The user can open an alternative visualization context with `PetscViewerASCIIOpen()` | ||
| 50 | to output to a specified file. | ||
| 51 | |||
| 52 | Level: beginner | ||
| 53 | |||
| 54 | .seealso: [](ch:mfn), `MFNCreate()`, `MFNViewFromOptions()` | ||
| 55 | @*/ | ||
| 56 | 30 | PetscErrorCode MFNView(MFN mfn,PetscViewer viewer) | |
| 57 | { | ||
| 58 | 30 | PetscBool isascii; | |
| 59 | |||
| 60 |
1/2✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
|
30 | PetscFunctionBegin; |
| 61 |
3/16✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✓ Branch 9 taken 2 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
✗ Branch 14 not taken.
✗ Branch 15 not taken.
|
30 | PetscValidHeaderSpecific(mfn,MFN_CLASSID,1); |
| 62 |
6/8✓ Branch 0 taken 10 times.
✓ Branch 1 taken 10 times.
✓ Branch 2 taken 2 times.
✓ Branch 3 taken 8 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 2 times.
|
30 | if (!viewer) PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)mfn),&viewer)); |
| 63 |
3/16✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✓ Branch 9 taken 2 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
✗ Branch 14 not taken.
✗ Branch 15 not taken.
|
30 | PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); |
| 64 |
13/32✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
✓ Branch 12 taken 2 times.
✗ Branch 13 not taken.
✗ Branch 14 not taken.
✓ Branch 15 taken 2 times.
✓ Branch 16 taken 2 times.
✗ Branch 17 not taken.
✓ Branch 18 taken 2 times.
✗ Branch 19 not taken.
✗ Branch 20 not taken.
✓ Branch 21 taken 2 times.
✗ Branch 22 not taken.
✗ Branch 23 not taken.
✗ Branch 24 not taken.
✓ Branch 25 taken 2 times.
✗ Branch 26 not taken.
✗ Branch 27 not taken.
✗ Branch 28 not taken.
✓ Branch 29 taken 2 times.
✗ Branch 30 not taken.
✗ Branch 31 not taken.
|
30 | PetscCheckSameComm(mfn,1,viewer,2); |
| 65 | |||
| 66 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
30 | PetscCall(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii)); |
| 67 |
1/2✓ Branch 0 taken 10 times.
✗ Branch 1 not taken.
|
30 | if (isascii) { |
| 68 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
30 | PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)mfn,viewer)); |
| 69 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
30 | PetscCall(PetscViewerASCIIPushTab(viewer)); |
| 70 |
1/8✗ Branch 0 not taken.
✓ Branch 1 taken 10 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
|
30 | PetscTryTypeMethod(mfn,view,viewer); |
| 71 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
30 | PetscCall(PetscViewerASCIIPopTab(viewer)); |
| 72 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
30 | PetscCall(PetscViewerASCIIPrintf(viewer," number of column vectors (ncv): %" PetscInt_FMT "\n",mfn->ncv)); |
| 73 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
30 | PetscCall(PetscViewerASCIIPrintf(viewer," maximum number of iterations: %" PetscInt_FMT "\n",mfn->max_it)); |
| 74 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
30 | PetscCall(PetscViewerASCIIPrintf(viewer," tolerance: %g\n",(double)mfn->tol)); |
| 75 | ✗ | } else PetscTryTypeMethod(mfn,view,viewer); | |
| 76 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
30 | PetscCall(PetscViewerPushFormat(viewer,PETSC_VIEWER_ASCII_INFO)); |
| 77 |
1/8✗ Branch 0 not taken.
✓ Branch 1 taken 10 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
|
30 | if (!mfn->V) PetscCall(MFNGetFN(mfn,&mfn->fn)); |
| 78 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
30 | PetscCall(FNView(mfn->fn,viewer)); |
| 79 |
1/8✗ Branch 0 not taken.
✓ Branch 1 taken 10 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
|
30 | if (!mfn->V) PetscCall(MFNGetBV(mfn,&mfn->V)); |
| 80 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
30 | PetscCall(BVView(mfn->V,viewer)); |
| 81 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
30 | PetscCall(PetscViewerPopFormat(viewer)); |
| 82 |
6/12✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
6 | PetscFunctionReturn(PETSC_SUCCESS); |
| 83 | } | ||
| 84 | |||
| 85 | /*@ | ||
| 86 | MFNViewFromOptions - View (print) an `MFN` object based on values in the options database. | ||
| 87 | |||
| 88 | Collective | ||
| 89 | |||
| 90 | Input Parameters: | ||
| 91 | + mfn - the matrix function solver context | ||
| 92 | . obj - optional object that provides the options prefix used to query the options database | ||
| 93 | - name - command line option | ||
| 94 | |||
| 95 | Level: intermediate | ||
| 96 | |||
| 97 | .seealso: [](ch:mfn), `MFNView()`, `MFNCreate()`, `PetscObjectViewFromOptions()` | ||
| 98 | @*/ | ||
| 99 | 2100 | PetscErrorCode MFNViewFromOptions(MFN mfn,PetscObject obj,const char name[]) | |
| 100 | { | ||
| 101 |
1/2✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
|
2100 | PetscFunctionBegin; |
| 102 |
3/16✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✓ Branch 9 taken 2 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
✗ Branch 14 not taken.
✗ Branch 15 not taken.
|
2100 | PetscValidHeaderSpecific(mfn,MFN_CLASSID,1); |
| 103 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
2100 | PetscCall(PetscObjectViewFromOptions((PetscObject)mfn,obj,name)); |
| 104 |
6/12✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
412 | PetscFunctionReturn(PETSC_SUCCESS); |
| 105 | } | ||
| 106 | /*@ | ||
| 107 | MFNConvergedReasonView - Displays the reason an `MFN` solve converged or diverged. | ||
| 108 | |||
| 109 | Collective | ||
| 110 | |||
| 111 | Input Parameters: | ||
| 112 | + mfn - the matrix function solver context | ||
| 113 | - viewer - the viewer to display the reason | ||
| 114 | |||
| 115 | Options Database Key: | ||
| 116 | . -mfn_converged_reason - print reason for convergence/divergence, and number of iterations | ||
| 117 | |||
| 118 | Notes: | ||
| 119 | Use `MFNConvergedReasonViewFromOptions()` to display the reason based on values | ||
| 120 | in the options database. | ||
| 121 | |||
| 122 | To change the format of the output call `PetscViewerPushFormat()` before this | ||
| 123 | call. Use `PETSC_VIEWER_DEFAULT` for the default, or `PETSC_VIEWER_FAILED` to only | ||
| 124 | display a reason if it fails. The latter can be set in the command line with | ||
| 125 | `-mfn_converged_reason ::failed`. | ||
| 126 | |||
| 127 | Level: intermediate | ||
| 128 | |||
| 129 | .seealso: [](ch:mfn), `MFNSetTolerances()`, `MFNGetIterationNumber()`, `MFNConvergedReasonViewFromOptions()` | ||
| 130 | @*/ | ||
| 131 | 20 | PetscErrorCode MFNConvergedReasonView(MFN mfn,PetscViewer viewer) | |
| 132 | { | ||
| 133 | 20 | PetscBool isAscii; | |
| 134 | 20 | PetscViewerFormat format; | |
| 135 | |||
| 136 |
1/2✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
|
20 | PetscFunctionBegin; |
| 137 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 10 times.
|
20 | if (!viewer) viewer = PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)mfn)); |
| 138 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
20 | PetscCall(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isAscii)); |
| 139 |
1/2✓ Branch 0 taken 10 times.
✗ Branch 1 not taken.
|
20 | if (isAscii) { |
| 140 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
20 | PetscCall(PetscViewerGetFormat(viewer,&format)); |
| 141 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
20 | PetscCall(PetscViewerASCIIAddTab(viewer,((PetscObject)mfn)->tablevel)); |
| 142 |
8/12✓ Branch 0 taken 10 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 10 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 2 times.
✓ Branch 5 taken 8 times.
✓ Branch 6 taken 2 times.
✓ Branch 7 taken 8 times.
✗ Branch 8 not taken.
✓ Branch 9 taken 2 times.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
20 | if (mfn->reason > 0 && format != PETSC_VIEWER_FAILED) PetscCall(PetscViewerASCIIPrintf(viewer,"%s Matrix function solve converged due to %s; iterations %" PetscInt_FMT "\n",((PetscObject)mfn)->prefix?((PetscObject)mfn)->prefix:"",MFNConvergedReasons[mfn->reason],mfn->its)); |
| 143 | ✗ | else if (mfn->reason <= 0) PetscCall(PetscViewerASCIIPrintf(viewer,"%s Matrix function solve did not converge due to %s; iterations %" PetscInt_FMT "\n",((PetscObject)mfn)->prefix?((PetscObject)mfn)->prefix:"",MFNConvergedReasons[mfn->reason],mfn->its)); | |
| 144 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
20 | PetscCall(PetscViewerASCIISubtractTab(viewer,((PetscObject)mfn)->tablevel)); |
| 145 | } | ||
| 146 |
6/12✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
4 | PetscFunctionReturn(PETSC_SUCCESS); |
| 147 | } | ||
| 148 | |||
| 149 | /*@ | ||
| 150 | MFNConvergedReasonViewFromOptions - Processes command line options to determine if/how | ||
| 151 | the `MFN` converged reason is to be viewed. | ||
| 152 | |||
| 153 | Collective | ||
| 154 | |||
| 155 | Input Parameter: | ||
| 156 | . mfn - the matrix function solver context | ||
| 157 | |||
| 158 | Level: intermediate | ||
| 159 | |||
| 160 | .seealso: [](ch:mfn), `MFNConvergedReasonView()` | ||
| 161 | @*/ | ||
| 162 | 1050 | PetscErrorCode MFNConvergedReasonViewFromOptions(MFN mfn) | |
| 163 | { | ||
| 164 | 1050 | PetscViewer viewer; | |
| 165 | 1050 | PetscBool flg; | |
| 166 | 1050 | static PetscBool incall = PETSC_FALSE; | |
| 167 | 1050 | PetscViewerFormat format; | |
| 168 | |||
| 169 |
1/2✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
|
1050 | PetscFunctionBegin; |
| 170 |
2/14✓ Branch 0 taken 8 times.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
|
1050 | if (incall) PetscFunctionReturn(PETSC_SUCCESS); |
| 171 | 1050 | incall = PETSC_TRUE; | |
| 172 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
1050 | PetscCall(PetscOptionsCreateViewer(PetscObjectComm((PetscObject)mfn),((PetscObject)mfn)->options,((PetscObject)mfn)->prefix,"-mfn_converged_reason",&viewer,&format,&flg)); |
| 173 |
2/2✓ Branch 0 taken 10 times.
✓ Branch 1 taken 10 times.
|
1050 | if (flg) { |
| 174 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
20 | PetscCall(PetscViewerPushFormat(viewer,format)); |
| 175 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
20 | PetscCall(MFNConvergedReasonView(mfn,viewer)); |
| 176 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
20 | PetscCall(PetscViewerPopFormat(viewer)); |
| 177 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
20 | PetscCall(PetscViewerDestroy(&viewer)); |
| 178 | } | ||
| 179 | 1050 | incall = PETSC_FALSE; | |
| 180 |
6/12✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
1050 | PetscFunctionReturn(PETSC_SUCCESS); |
| 181 | } | ||
| 182 | |||
| 183 | /*@ | ||
| 184 | MFNCreate - Creates the `MFN` context. | ||
| 185 | |||
| 186 | Collective | ||
| 187 | |||
| 188 | Input Parameter: | ||
| 189 | . comm - MPI communicator | ||
| 190 | |||
| 191 | Output Parameter: | ||
| 192 | . outmfn - location to put the `MFN` context | ||
| 193 | |||
| 194 | Note: | ||
| 195 | The default `MFN` type is `MFNKRYLOV`. | ||
| 196 | |||
| 197 | Level: beginner | ||
| 198 | |||
| 199 | .seealso: [](ch:mfn), `MFNSetUp()`, `MFNSolve()`, `MFNDestroy()`, `MFN` | ||
| 200 | @*/ | ||
| 201 | 297 | PetscErrorCode MFNCreate(MPI_Comm comm,MFN *outmfn) | |
| 202 | { | ||
| 203 | 297 | MFN mfn; | |
| 204 | |||
| 205 |
1/2✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
|
297 | PetscFunctionBegin; |
| 206 |
2/8✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
|
297 | PetscAssertPointer(outmfn,2); |
| 207 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
297 | PetscCall(MFNInitializePackage()); |
| 208 |
7/12✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 10 times.
✗ Branch 6 not taken.
✓ Branch 7 taken 8 times.
✗ Branch 8 not taken.
✓ Branch 9 taken 2 times.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
297 | PetscCall(SlepcHeaderCreate(mfn,MFN_CLASSID,"MFN","Matrix Function","MFN",comm,MFNDestroy,MFNView)); |
| 209 | |||
| 210 | 297 | mfn->A = NULL; | |
| 211 | 297 | mfn->fn = NULL; | |
| 212 | 297 | mfn->max_it = PETSC_DETERMINE; | |
| 213 | 297 | mfn->ncv = PETSC_DETERMINE; | |
| 214 | 297 | mfn->tol = PETSC_DETERMINE; | |
| 215 | 297 | mfn->errorifnotconverged = PETSC_FALSE; | |
| 216 | |||
| 217 | 297 | mfn->numbermonitors = 0; | |
| 218 | |||
| 219 | 297 | mfn->V = NULL; | |
| 220 | 297 | mfn->nwork = 0; | |
| 221 | 297 | mfn->work = NULL; | |
| 222 | 297 | mfn->data = NULL; | |
| 223 | |||
| 224 | 297 | mfn->its = 0; | |
| 225 | 297 | mfn->nv = 0; | |
| 226 | 297 | mfn->errest = 0; | |
| 227 | 297 | mfn->setupcalled = 0; | |
| 228 | 297 | mfn->reason = MFN_CONVERGED_ITERATING; | |
| 229 | |||
| 230 | 297 | *outmfn = mfn; | |
| 231 |
6/12✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
297 | PetscFunctionReturn(PETSC_SUCCESS); |
| 232 | } | ||
| 233 | |||
| 234 | /*@ | ||
| 235 | MFNSetType - Selects the particular solver to be used in the `MFN` object. | ||
| 236 | |||
| 237 | Logically Collective | ||
| 238 | |||
| 239 | Input Parameters: | ||
| 240 | + mfn - the matrix function solver context | ||
| 241 | - type - a known method | ||
| 242 | |||
| 243 | Options Database Key: | ||
| 244 | . -mfn_type type - sets the method; use `-help` for a list of available methods | ||
| 245 | |||
| 246 | Notes: | ||
| 247 | See `MFNType` for available methods. The default is `MFNKRYLOV`. | ||
| 248 | |||
| 249 | Normally, it is best to use the `MFNSetFromOptions()` command and | ||
| 250 | then set the `MFN` type from the options database rather than by using | ||
| 251 | this routine. Using the options database provides the user with | ||
| 252 | maximum flexibility in evaluating the different available methods. | ||
| 253 | The `MFNSetType()` routine is provided for those situations where it | ||
| 254 | is necessary to set the iterative solver independently of the command | ||
| 255 | line or options database. | ||
| 256 | |||
| 257 | Level: intermediate | ||
| 258 | |||
| 259 | .seealso: [](ch:mfn), `MFNType` | ||
| 260 | @*/ | ||
| 261 | 216 | PetscErrorCode MFNSetType(MFN mfn,MFNType type) | |
| 262 | { | ||
| 263 | 216 | PetscErrorCode (*r)(MFN); | |
| 264 | 216 | PetscBool match; | |
| 265 | |||
| 266 |
1/2✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
|
216 | PetscFunctionBegin; |
| 267 |
3/16✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✓ Branch 9 taken 2 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
✗ Branch 14 not taken.
✗ Branch 15 not taken.
|
216 | PetscValidHeaderSpecific(mfn,MFN_CLASSID,1); |
| 268 |
2/8✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
|
216 | PetscAssertPointer(type,2); |
| 269 | |||
| 270 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
216 | PetscCall(PetscObjectTypeCompare((PetscObject)mfn,type,&match)); |
| 271 |
2/14✓ Branch 0 taken 8 times.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
|
216 | if (match) PetscFunctionReturn(PETSC_SUCCESS); |
| 272 | |||
| 273 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
216 | PetscCall(PetscFunctionListFind(MFNList,type,&r)); |
| 274 |
1/4✗ Branch 0 not taken.
✓ Branch 1 taken 10 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
|
216 | PetscCheck(r,PetscObjectComm((PetscObject)mfn),PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown MFN type given: %s",type); |
| 275 | |||
| 276 |
1/8✗ Branch 0 not taken.
✓ Branch 1 taken 10 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
|
216 | PetscTryTypeMethod(mfn,destroy); |
| 277 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 5 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
216 | PetscCall(PetscMemzero(mfn->ops,sizeof(struct _MFNOps))); |
| 278 | |||
| 279 | 216 | mfn->setupcalled = 0; | |
| 280 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
216 | PetscCall(PetscObjectChangeTypeName((PetscObject)mfn,type)); |
| 281 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
216 | PetscCall((*r)(mfn)); |
| 282 |
6/12✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
38 | PetscFunctionReturn(PETSC_SUCCESS); |
| 283 | } | ||
| 284 | |||
| 285 | /*@ | ||
| 286 | MFNGetType - Gets the `MFN` type as a string from the `MFN` object. | ||
| 287 | |||
| 288 | Not Collective | ||
| 289 | |||
| 290 | Input Parameter: | ||
| 291 | . mfn - the matrix function solver context | ||
| 292 | |||
| 293 | Output Parameter: | ||
| 294 | . type - name of `MFN` method | ||
| 295 | |||
| 296 | Note: | ||
| 297 | `type` should not be retained for later use as it will be an invalid pointer | ||
| 298 | if the `MFNType` of `mfn` is changed. | ||
| 299 | |||
| 300 | Level: intermediate | ||
| 301 | |||
| 302 | .seealso: [](ch:mfn), `MFNSetType()`, `PetscObjectTypeCompare()`, `PetscObjectTypeCompareAny()` | ||
| 303 | @*/ | ||
| 304 | 46 | PetscErrorCode MFNGetType(MFN mfn,MFNType *type) | |
| 305 | { | ||
| 306 |
1/2✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
|
46 | PetscFunctionBegin; |
| 307 |
3/16✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✓ Branch 9 taken 2 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
✗ Branch 14 not taken.
✗ Branch 15 not taken.
|
46 | PetscValidHeaderSpecific(mfn,MFN_CLASSID,1); |
| 308 |
2/8✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
|
46 | PetscAssertPointer(type,2); |
| 309 | 46 | *type = ((PetscObject)mfn)->type_name; | |
| 310 |
6/12✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
46 | PetscFunctionReturn(PETSC_SUCCESS); |
| 311 | } | ||
| 312 | |||
| 313 | /*@C | ||
| 314 | MFNRegister - Adds a method to the matrix function solver package. | ||
| 315 | |||
| 316 | Not Collective | ||
| 317 | |||
| 318 | Input Parameters: | ||
| 319 | + name - name of a new user-defined solver | ||
| 320 | - function - routine to create the solver context | ||
| 321 | |||
| 322 | Note: | ||
| 323 | `MFNRegister()` may be called multiple times to add several user-defined solvers. | ||
| 324 | |||
| 325 | Example Usage: | ||
| 326 | .vb | ||
| 327 | MFNRegister("my_solver",MySolverCreate); | ||
| 328 | .ve | ||
| 329 | |||
| 330 | Then, your solver can be chosen with the procedural interface via | ||
| 331 | .vb | ||
| 332 | MFNSetType(mfn,"my_solver") | ||
| 333 | .ve | ||
| 334 | or at runtime via the option `-mfn_type my_solver`. | ||
| 335 | |||
| 336 | Level: advanced | ||
| 337 | |||
| 338 | .seealso: [](ch:mfn), `MFNRegisterAll()` | ||
| 339 | @*/ | ||
| 340 | 434 | PetscErrorCode MFNRegister(const char *name,PetscErrorCode (*function)(MFN)) | |
| 341 | { | ||
| 342 |
1/2✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
|
434 | PetscFunctionBegin; |
| 343 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
434 | PetscCall(MFNInitializePackage()); |
| 344 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
434 | PetscCall(PetscFunctionListAdd(&MFNList,name,function)); |
| 345 |
6/12✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
68 | PetscFunctionReturn(PETSC_SUCCESS); |
| 346 | } | ||
| 347 | |||
| 348 | /*@C | ||
| 349 | MFNMonitorRegister - Registers an `MFN` monitor routine that may be accessed with | ||
| 350 | `MFNMonitorSetFromOptions()`. | ||
| 351 | |||
| 352 | Not Collective | ||
| 353 | |||
| 354 | Input Parameters: | ||
| 355 | + name - name of a new monitor routine | ||
| 356 | . vtype - a `PetscViewerType` for the output | ||
| 357 | . format - a `PetscViewerFormat` for the output | ||
| 358 | . monitor - monitor routine, see `MFNMonitorRegisterFn` | ||
| 359 | . create - creation routine, or `NULL` | ||
| 360 | - destroy - destruction routine, or `NULL` | ||
| 361 | |||
| 362 | Notes: | ||
| 363 | `MFNMonitorRegister()` may be called multiple times to add several user-defined monitors. | ||
| 364 | |||
| 365 | The calling sequence for the given function matches the calling sequence of `MFNMonitorFn` | ||
| 366 | functions passed to `MFNMonitorSet()` with the additional requirement that its final argument | ||
| 367 | be a `PetscViewerAndFormat`. | ||
| 368 | |||
| 369 | Example Usage: | ||
| 370 | .vb | ||
| 371 | MFNMonitorRegister("my_monitor",PETSCVIEWERASCII,PETSC_VIEWER_ASCII_INFO_DETAIL,MyMonitor,NULL,NULL); | ||
| 372 | .ve | ||
| 373 | |||
| 374 | Then, your monitor can be chosen with the procedural interface via | ||
| 375 | .vb | ||
| 376 | MFNMonitorSetFromOptions(mfn,"-mfn_monitor_my_monitor","my_monitor",NULL); | ||
| 377 | .ve | ||
| 378 | or at runtime via the option `-mfn_monitor_my_monitor`. | ||
| 379 | |||
| 380 | Level: advanced | ||
| 381 | |||
| 382 | .seealso: [](ch:mfn), `MFNMonitorSet()`, `MFNMonitorRegisterAll()`, `MFNMonitorSetFromOptions()` | ||
| 383 | @*/ | ||
| 384 | 434 | PetscErrorCode MFNMonitorRegister(const char name[],PetscViewerType vtype,PetscViewerFormat format,MFNMonitorRegisterFn *monitor,MFNMonitorRegisterCreateFn *create,MFNMonitorRegisterDestroyFn *destroy) | |
| 385 | { | ||
| 386 | 434 | char key[PETSC_MAX_PATH_LEN]; | |
| 387 | |||
| 388 |
1/2✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
|
434 | PetscFunctionBegin; |
| 389 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
434 | PetscCall(MFNInitializePackage()); |
| 390 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
434 | PetscCall(SlepcMonitorMakeKey_Internal(name,vtype,format,key)); |
| 391 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
434 | PetscCall(PetscFunctionListAdd(&MFNMonitorList,key,monitor)); |
| 392 |
6/8✓ Branch 0 taken 10 times.
✓ Branch 1 taken 10 times.
✓ Branch 2 taken 2 times.
✓ Branch 3 taken 8 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 2 times.
|
434 | if (create) PetscCall(PetscFunctionListAdd(&MFNMonitorCreateList,key,create)); |
| 393 |
1/8✗ Branch 0 not taken.
✓ Branch 1 taken 10 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
|
434 | if (destroy) PetscCall(PetscFunctionListAdd(&MFNMonitorDestroyList,key,destroy)); |
| 394 |
6/12✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
68 | PetscFunctionReturn(PETSC_SUCCESS); |
| 395 | } | ||
| 396 | |||
| 397 | /*@ | ||
| 398 | MFNReset - Resets the `MFN` context to the initial state (prior to setup) | ||
| 399 | and destroys any allocated `Vec`s and `Mat`s. | ||
| 400 | |||
| 401 | Collective | ||
| 402 | |||
| 403 | Input Parameter: | ||
| 404 | . mfn - the matrix function solver context | ||
| 405 | |||
| 406 | Level: advanced | ||
| 407 | |||
| 408 | .seealso: [](ch:mfn), `MFNDestroy()` | ||
| 409 | @*/ | ||
| 410 | 297 | PetscErrorCode MFNReset(MFN mfn) | |
| 411 | { | ||
| 412 |
1/2✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
|
297 | PetscFunctionBegin; |
| 413 |
3/14✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 2 times.
✗ Branch 8 not taken.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
|
297 | if (mfn) PetscValidHeaderSpecific(mfn,MFN_CLASSID,1); |
| 414 |
1/12✓ Branch 0 taken 8 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
|
261 | if (!mfn) PetscFunctionReturn(PETSC_SUCCESS); |
| 415 |
1/8✗ Branch 0 not taken.
✓ Branch 1 taken 10 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
|
297 | PetscTryTypeMethod(mfn,reset); |
| 416 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
297 | PetscCall(MatDestroy(&mfn->A)); |
| 417 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
297 | PetscCall(BVDestroy(&mfn->V)); |
| 418 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
297 | PetscCall(VecDestroyVecs(mfn->nwork,&mfn->work)); |
| 419 | 297 | mfn->nwork = 0; | |
| 420 | 297 | mfn->setupcalled = 0; | |
| 421 |
6/12✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
297 | PetscFunctionReturn(PETSC_SUCCESS); |
| 422 | } | ||
| 423 | |||
| 424 | /*@ | ||
| 425 | MFNDestroy - Destroys the `MFN` context. | ||
| 426 | |||
| 427 | Collective | ||
| 428 | |||
| 429 | Input Parameter: | ||
| 430 | . mfn - the matrix function solver context | ||
| 431 | |||
| 432 | Level: beginner | ||
| 433 | |||
| 434 | .seealso: [](ch:mfn), `MFNCreate()`, `MFNSetUp()`, `MFNSolve()` | ||
| 435 | @*/ | ||
| 436 | 318 | PetscErrorCode MFNDestroy(MFN *mfn) | |
| 437 | { | ||
| 438 |
1/2✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
|
318 | PetscFunctionBegin; |
| 439 |
2/14✓ Branch 0 taken 8 times.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
|
318 | if (!*mfn) PetscFunctionReturn(PETSC_SUCCESS); |
| 440 |
2/12✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
|
318 | PetscValidHeaderSpecific(*mfn,MFN_CLASSID,1); |
| 441 |
2/14✓ Branch 0 taken 2 times.
✓ Branch 1 taken 10 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
|
318 | if (--((PetscObject)*mfn)->refct > 0) { *mfn = NULL; PetscFunctionReturn(PETSC_SUCCESS); } |
| 442 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
297 | PetscCall(MFNReset(*mfn)); |
| 443 |
1/8✗ Branch 0 not taken.
✓ Branch 1 taken 10 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
|
297 | PetscTryTypeMethod(*mfn,destroy); |
| 444 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
297 | PetscCall(FNDestroy(&(*mfn)->fn)); |
| 445 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
297 | PetscCall(MatDestroy(&(*mfn)->AT)); |
| 446 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
297 | PetscCall(MFNMonitorCancel(*mfn)); |
| 447 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
297 | PetscCall(PetscHeaderDestroy(mfn)); |
| 448 |
6/12✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
36 | PetscFunctionReturn(PETSC_SUCCESS); |
| 449 | } | ||
| 450 | |||
| 451 | /*@ | ||
| 452 | MFNSetBV - Associates a basis vectors object to the matrix function solver. | ||
| 453 | |||
| 454 | Collective | ||
| 455 | |||
| 456 | Input Parameters: | ||
| 457 | + mfn - the matrix function solver context | ||
| 458 | - bv - the basis vectors object | ||
| 459 | |||
| 460 | Note: | ||
| 461 | Use `MFNGetBV()` to retrieve the basis vectors context (for example, | ||
| 462 | to free it at the end of the computations). | ||
| 463 | |||
| 464 | Level: advanced | ||
| 465 | |||
| 466 | .seealso: [](ch:mfn), `MFNGetBV()` | ||
| 467 | @*/ | ||
| 468 | 8 | PetscErrorCode MFNSetBV(MFN mfn,BV bv) | |
| 469 | { | ||
| 470 |
1/2✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
|
8 | PetscFunctionBegin; |
| 471 |
3/16✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✓ Branch 9 taken 2 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
✗ Branch 14 not taken.
✗ Branch 15 not taken.
|
8 | PetscValidHeaderSpecific(mfn,MFN_CLASSID,1); |
| 472 |
3/16✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✓ Branch 9 taken 2 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
✗ Branch 14 not taken.
✗ Branch 15 not taken.
|
8 | PetscValidHeaderSpecific(bv,BV_CLASSID,2); |
| 473 |
13/32✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
✓ Branch 12 taken 2 times.
✗ Branch 13 not taken.
✗ Branch 14 not taken.
✓ Branch 15 taken 2 times.
✓ Branch 16 taken 2 times.
✗ Branch 17 not taken.
✓ Branch 18 taken 2 times.
✗ Branch 19 not taken.
✗ Branch 20 not taken.
✓ Branch 21 taken 2 times.
✗ Branch 22 not taken.
✗ Branch 23 not taken.
✗ Branch 24 not taken.
✓ Branch 25 taken 2 times.
✗ Branch 26 not taken.
✗ Branch 27 not taken.
✗ Branch 28 not taken.
✓ Branch 29 taken 2 times.
✗ Branch 30 not taken.
✗ Branch 31 not taken.
|
8 | PetscCheckSameComm(mfn,1,bv,2); |
| 474 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 6 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
8 | PetscCall(PetscObjectReference((PetscObject)bv)); |
| 475 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 6 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
8 | PetscCall(BVDestroy(&mfn->V)); |
| 476 | 8 | mfn->V = bv; | |
| 477 |
6/12✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
8 | PetscFunctionReturn(PETSC_SUCCESS); |
| 478 | } | ||
| 479 | |||
| 480 | /*@ | ||
| 481 | MFNGetBV - Obtain the basis vectors object associated to the matrix | ||
| 482 | function solver. | ||
| 483 | |||
| 484 | Not Collective | ||
| 485 | |||
| 486 | Input Parameter: | ||
| 487 | . mfn - the matrix function solver context | ||
| 488 | |||
| 489 | Output Parameter: | ||
| 490 | . bv - basis vectors context | ||
| 491 | |||
| 492 | Level: advanced | ||
| 493 | |||
| 494 | .seealso: [](ch:mfn), `MFNSetBV()` | ||
| 495 | @*/ | ||
| 496 | 198 | PetscErrorCode MFNGetBV(MFN mfn,BV *bv) | |
| 497 | { | ||
| 498 |
1/2✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
|
198 | PetscFunctionBegin; |
| 499 |
3/16✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✓ Branch 9 taken 2 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
✗ Branch 14 not taken.
✗ Branch 15 not taken.
|
198 | PetscValidHeaderSpecific(mfn,MFN_CLASSID,1); |
| 500 |
2/8✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
|
198 | PetscAssertPointer(bv,2); |
| 501 |
1/2✓ Branch 0 taken 10 times.
✗ Branch 1 not taken.
|
198 | if (!mfn->V) { |
| 502 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
198 | PetscCall(BVCreate(PetscObjectComm((PetscObject)mfn),&mfn->V)); |
| 503 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
198 | PetscCall(PetscObjectIncrementTabLevel((PetscObject)mfn->V,(PetscObject)mfn,0)); |
| 504 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
198 | PetscCall(PetscObjectSetOptions((PetscObject)mfn->V,((PetscObject)mfn)->options)); |
| 505 | } | ||
| 506 | 198 | *bv = mfn->V; | |
| 507 |
6/12✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
198 | PetscFunctionReturn(PETSC_SUCCESS); |
| 508 | } | ||
| 509 | |||
| 510 | /*@ | ||
| 511 | MFNSetFN - Specifies the function to be computed. | ||
| 512 | |||
| 513 | Collective | ||
| 514 | |||
| 515 | Input Parameters: | ||
| 516 | + mfn - the matrix function solver context | ||
| 517 | - fn - the math function object | ||
| 518 | |||
| 519 | Notes: | ||
| 520 | At a later time, use `MFNGetFN()` to retrieve the math function context | ||
| 521 | (for example, to free it at the end of the computations). | ||
| 522 | |||
| 523 | This function is not called in normal usage. Instead, it is easier to | ||
| 524 | extract the internal `FN` object with `MFNGetFN()` and modify it. | ||
| 525 | |||
| 526 | Level: beginner | ||
| 527 | |||
| 528 | .seealso: [](ch:mfn), `MFNGetFN()` | ||
| 529 | @*/ | ||
| 530 | 48 | PetscErrorCode MFNSetFN(MFN mfn,FN fn) | |
| 531 | { | ||
| 532 |
1/2✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
|
48 | PetscFunctionBegin; |
| 533 |
3/16✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✓ Branch 9 taken 2 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
✗ Branch 14 not taken.
✗ Branch 15 not taken.
|
48 | PetscValidHeaderSpecific(mfn,MFN_CLASSID,1); |
| 534 |
3/16✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✓ Branch 9 taken 2 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
✗ Branch 14 not taken.
✗ Branch 15 not taken.
|
48 | PetscValidHeaderSpecific(fn,FN_CLASSID,2); |
| 535 |
13/32✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
✓ Branch 12 taken 2 times.
✗ Branch 13 not taken.
✗ Branch 14 not taken.
✓ Branch 15 taken 2 times.
✓ Branch 16 taken 2 times.
✗ Branch 17 not taken.
✓ Branch 18 taken 2 times.
✗ Branch 19 not taken.
✗ Branch 20 not taken.
✓ Branch 21 taken 2 times.
✗ Branch 22 not taken.
✗ Branch 23 not taken.
✗ Branch 24 not taken.
✓ Branch 25 taken 2 times.
✗ Branch 26 not taken.
✗ Branch 27 not taken.
✗ Branch 28 not taken.
✓ Branch 29 taken 2 times.
✗ Branch 30 not taken.
✗ Branch 31 not taken.
|
48 | PetscCheckSameComm(mfn,1,fn,2); |
| 536 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
48 | PetscCall(PetscObjectReference((PetscObject)fn)); |
| 537 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
48 | PetscCall(FNDestroy(&mfn->fn)); |
| 538 | 48 | mfn->fn = fn; | |
| 539 |
6/12✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
48 | PetscFunctionReturn(PETSC_SUCCESS); |
| 540 | } | ||
| 541 | |||
| 542 | /*@ | ||
| 543 | MFNGetFN - Obtain the math function object associated to the `MFN` object. | ||
| 544 | |||
| 545 | Not Collective | ||
| 546 | |||
| 547 | Input Parameter: | ||
| 548 | . mfn - the matrix function solver context | ||
| 549 | |||
| 550 | Output Parameter: | ||
| 551 | . fn - math function context | ||
| 552 | |||
| 553 | Note: | ||
| 554 | This is the usual way to specify the function that needs to be applied | ||
| 555 | to a given vector in `MFNSolve()`. | ||
| 556 | |||
| 557 | Level: beginner | ||
| 558 | |||
| 559 | .seealso: [](ch:mfn), `MFNSetFN()`, `MFNSolve()` | ||
| 560 | @*/ | ||
| 561 | 6048 | PetscErrorCode MFNGetFN(MFN mfn,FN *fn) | |
| 562 | { | ||
| 563 |
1/2✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
|
6048 | PetscFunctionBegin; |
| 564 |
3/16✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✓ Branch 9 taken 2 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
✗ Branch 14 not taken.
✗ Branch 15 not taken.
|
6048 | PetscValidHeaderSpecific(mfn,MFN_CLASSID,1); |
| 565 |
2/8✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
|
6048 | PetscAssertPointer(fn,2); |
| 566 |
2/2✓ Branch 0 taken 10 times.
✓ Branch 1 taken 10 times.
|
6048 | if (!mfn->fn) { |
| 567 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
158 | PetscCall(FNCreate(PetscObjectComm((PetscObject)mfn),&mfn->fn)); |
| 568 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
158 | PetscCall(PetscObjectIncrementTabLevel((PetscObject)mfn->fn,(PetscObject)mfn,0)); |
| 569 |
4/6✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
|
158 | PetscCall(PetscObjectSetOptions((PetscObject)mfn->fn,((PetscObject)mfn)->options)); |
| 570 | } | ||
| 571 | 6048 | *fn = mfn->fn; | |
| 572 |
6/12✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 2 times.
|
6048 | PetscFunctionReturn(PETSC_SUCCESS); |
| 573 | } | ||
| 574 |