/*@
MFNSolve - Solves the matrix function problem. Given a vector b, the
vector x = f(alpha*A)*b is returned.
Collective on MFN
Input Parameters:
+ mfn - matrix function context obtained from MFNCreate()
- b - the right hand side vector
Output Parameter:
. x - the solution (this may be the same vector as b, then b will be
overwritten with the answer)
Options Database Keys:
+ -mfn_view - print information about the solver used
. -mfn_view_mat binary - save the matrix to the default binary viewer
. -mfn_view_rhs binary - save right hand side vector to the default binary viewer
- -mfn_view_solution binary - save computed solution vector to the default binary viewer
Notes:
The matrix A is specified with MFNSetOperator().
The function f is specified with MFNSetFunction().
The scalar alpha is specified with MFNSetScaleFactor().
Level: beginner
.seealso: MFNCreate(), MFNSetUp(), MFNDestroy(), MFNSetTolerances(),
MFNSetOperator(), MFNSetFunction(), MFNSetScaleFactor()
@*/
PetscErrorCode MFNSolve(MFN mfn,Vec b,Vec x)
{
PetscErrorCode ierr;
PetscBool flg;
PetscViewer viewer;
PetscViewerFormat format;
PetscFunctionBegin;
PetscValidHeaderSpecific(mfn,MFN_CLASSID,1);
PetscValidHeaderSpecific(b,VEC_CLASSID,2);
PetscCheckSameComm(mfn,1,b,2);
if (b!=x) PetscValidHeaderSpecific(x,VEC_CLASSID,3);
if (b!=x) PetscCheckSameComm(mfn,1,x,3);
/* call setup */
ierr = MFNSetUp(mfn);CHKERRQ(ierr);
mfn->its = 0;
ierr = MFNMonitor(mfn,mfn->its,0);CHKERRQ(ierr);
/* call solver */
ierr = PetscLogEventBegin(MFN_Solve,mfn,b,x,0);CHKERRQ(ierr);
ierr = (*mfn->ops->solve)(mfn,b,x);CHKERRQ(ierr);
ierr = PetscLogEventEnd(MFN_Solve,mfn,b,x,0);CHKERRQ(ierr);
if (!mfn->reason) SETERRQ(PetscObjectComm((PetscObject)mfn),PETSC_ERR_PLIB,"Internal error, solver returned without setting converged reason");
if (mfn->errorifnotconverged && mfn->reason < 0) SETERRQ(PetscObjectComm((PetscObject)mfn),PETSC_ERR_NOT_CONVERGED,"MFNSolve has not converged");
/* various viewers */
ierr = MatViewFromOptions(mfn->A,((PetscObject)mfn)->prefix,"-mfn_view_mat");CHKERRQ(ierr);
ierr = VecViewFromOptions(b,((PetscObject)mfn)->prefix,"-mfn_view_rhs");CHKERRQ(ierr);
ierr = VecViewFromOptions(x,((PetscObject)mfn)->prefix,"-mfn_view_solution");CHKERRQ(ierr);
ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)mfn),((PetscObject)mfn)->prefix,"-mfn_view",&viewer,&format,&flg);CHKERRQ(ierr);
if (flg && !PetscPreLoadingOn) {
ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr);
ierr = MFNView(mfn,viewer);CHKERRQ(ierr);
ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
}
PetscFunctionReturn(0);
}
PETSC_EXTERN void PETSC_STDCALL mfnsetup_(MFN *mfn, int *__ierr ) {
*__ierr = MFNSetUp(*mfn);
}
