/*
This file implements a wrapper to the BLOPEX solver
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
SLEPc - Scalable Library for Eigenvalue Problem Computations
Copyright (c) 2002-2009, Universidad Politecnica de Valencia, Spain
This file is part of SLEPc.
SLEPc is free software: you can redistribute it and/or modify it under the
terms of version 3 of the GNU Lesser General Public License as published by
the Free Software Foundation.
SLEPc is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
more details.
You should have received a copy of the GNU Lesser General Public License
along with SLEPc. If not, see <http://www.gnu.org/licenses/>.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
*/
#include "private/stimpl.h"
#include "private/epsimpl.h"
#include "slepc-interface.h"
#include "lobpcg.h"
#include "interpreter.h"
#include "multivector.h"
#include "temp_multivector.h"
PetscErrorCode EPSSolve_BLOPEX(EPS);
typedef struct {
lobpcg_Tolerance tol;
lobpcg_BLASLAPACKFunctions blap_fn;
mv_MultiVectorPtr eigenvectors;
mv_MultiVectorPtr Y;
mv_InterfaceInterpreter ii;
KSP ksp;
} EPS_BLOPEX;
#undef __FUNCT__
#define __FUNCT__ "Precond_FnSingleVector"
static void Precond_FnSingleVector(void *data,void *x,void *y)
{
PetscErrorCode ierr;
EPS eps = (EPS)data;
EPS_BLOPEX *blopex = (EPS_BLOPEX*)eps->data;
PetscInt lits;
PetscFunctionBegin;
ierr = KSPSolve(blopex->ksp,(Vec)x,(Vec)y); CHKERRABORT(PETSC_COMM_WORLD,ierr);
ierr = KSPGetIterationNumber(blopex->ksp, &lits); CHKERRABORT(PETSC_COMM_WORLD,ierr);
eps->OP->lineariterations+= lits;
PetscFunctionReturnVoid();
}
#undef __FUNCT__
#define __FUNCT__ "Precond_FnMultiVector"
static void Precond_FnMultiVector(void *data,void *x,void *y)
{
EPS eps = (EPS)data;
EPS_BLOPEX *blopex = (EPS_BLOPEX*)eps->data;
PetscFunctionBegin;
blopex->ii.Eval(Precond_FnSingleVector,data,x,y);
PetscFunctionReturnVoid();
}
#undef __FUNCT__
#define __FUNCT__ "OperatorASingleVector"
static void OperatorASingleVector(void *data,void *x,void *y)
{
PetscErrorCode ierr;
EPS eps = (EPS)data;
Mat A;
PetscFunctionBegin;
ierr = STGetOperators(eps->OP,&A,PETSC_NULL); CHKERRABORT(PETSC_COMM_WORLD,ierr);
ierr = MatMult(A,(Vec)x,(Vec)y); CHKERRABORT(PETSC_COMM_WORLD,ierr);
PetscFunctionReturnVoid();
}
#undef __FUNCT__
#define __FUNCT__ "OperatorAMultiVector"
static void OperatorAMultiVector(void *data,void *x,void *y)
{
EPS eps = (EPS)data;
EPS_BLOPEX *blopex = (EPS_BLOPEX*)eps->data;
PetscFunctionBegin;
blopex->ii.Eval(OperatorASingleVector,data,x,y);
PetscFunctionReturnVoid();
}
#undef __FUNCT__
#define __FUNCT__ "OperatorBSingleVector"
static void OperatorBSingleVector(void *data,void *x,void *y)
{
PetscErrorCode ierr;
EPS eps = (EPS)data;
Mat B;
PetscFunctionBegin;
ierr = STGetOperators(eps->OP,PETSC_NULL,&B); CHKERRABORT(PETSC_COMM_WORLD,ierr);
ierr = MatMult(B,(Vec)x,(Vec)y); CHKERRABORT(PETSC_COMM_WORLD,ierr);
PetscFunctionReturnVoid();
}
#undef __FUNCT__
#define __FUNCT__ "OperatorBMultiVector"
static void OperatorBMultiVector(void *data,void *x,void *y)
{
EPS eps = (EPS)data;
EPS_BLOPEX *blopex = (EPS_BLOPEX*)eps->data;
PetscFunctionBegin;
blopex->ii.Eval(OperatorBSingleVector,data,x,y);
PetscFunctionReturnVoid();
}
#undef __FUNCT__
#define __FUNCT__ "EPSSetUp_BLOPEX"
PetscErrorCode EPSSetUp_BLOPEX(EPS eps)
{
PetscErrorCode ierr;
EPS_BLOPEX *blopex = (EPS_BLOPEX *)eps->data;
PetscTruth isPrecond, isPreonly;
PetscFunctionBegin;
if (!eps->ishermitian) {
SETERRQ(PETSC_ERR_SUP,"blopex only works for hermitian problems");
}
if (!eps->which) eps->which = EPS_SMALLEST_REAL;
if (eps->which!=EPS_SMALLEST_REAL) {
SETERRQ(1,"Wrong value of eps->which");
}
ierr = STSetUp(eps->OP); CHKERRQ(ierr);
ierr = PetscTypeCompare((PetscObject)eps->OP, STPRECOND, &isPrecond); CHKERRQ(ierr);
if (isPrecond == PETSC_FALSE) SETERRQ(PETSC_ERR_SUP, "blopex only works with precond spectral transformation");
ierr = STGetKSP(eps->OP, &blopex->ksp); CHKERRQ(ierr);
ierr = PetscTypeCompare((PetscObject)blopex->ksp, KSPPREONLY, &isPreonly); CHKERRQ(ierr);
if (isPreonly == PETSC_FALSE)
SETERRQ(PETSC_ERR_SUP, "blopex only works with preonly ksp of the spectral transformation");
eps->ncv = eps->nev = PetscMin(eps->nev,eps->n);
if (eps->mpd) PetscInfo(eps,"Warning: parameter mpd ignored\n");
if (!eps->max_it) eps->max_it = PetscMax(100,2*eps->n/eps->ncv);
ierr = EPSAllocateSolution(eps);CHKERRQ(ierr);
ierr = EPSDefaultGetWork(eps,1);CHKERRQ(ierr);
blopex->tol.absolute = eps->tol;
blopex->tol.relative = 1e-50;
LOBPCG_InitRandomContext();
SLEPCSetupInterpreter(&blopex->ii);
blopex->eigenvectors = mv_MultiVectorCreateFromSampleVector(&blopex->ii,eps->ncv,eps->V);
mv_MultiVectorSetRandom(blopex->eigenvectors,1234);
if (eps->nds > 0) {
blopex->Y = mv_MultiVectorCreateFromSampleVector(&blopex->ii, eps->nds, eps->DS);
} else
blopex->Y = PETSC_NULL;
#ifdef PETSC_USE_COMPLEX
blopex->blap_fn.zpotrf = PETSC_zpotrf_interface;
blopex->blap_fn.zhegv = PETSC_zsygv_interface;
#else
blopex->blap_fn.dpotrf = PETSC_dpotrf_interface;
blopex->blap_fn.dsygv = PETSC_dsygv_interface;
#endif
if (eps->extraction) {
ierr = PetscInfo(eps,"Warning: extraction type ignored\n");CHKERRQ(ierr);
}
/* dispatch solve method */
if (eps->leftvecs) SETERRQ(PETSC_ERR_SUP,"Left vectors not supported in this solver");
eps->ops->solve = EPSSolve_BLOPEX;
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSSolve_BLOPEX"
PetscErrorCode EPSSolve_BLOPEX(EPS eps)
{
EPS_BLOPEX *blopex = (EPS_BLOPEX *)eps->data;
int info,its;
PetscFunctionBegin;
#ifdef PETSC_USE_COMPLEX
info = lobpcg_solve_complex(blopex->eigenvectors,eps,OperatorAMultiVector,
eps->isgeneralized?eps:PETSC_NULL,eps->isgeneralized?OperatorBMultiVector:PETSC_NULL,
eps,Precond_FnMultiVector,blopex->Y,
blopex->blap_fn,blopex->tol,eps->max_it,0,&its,
(komplex*)eps->eigr,PETSC_NULL,0,eps->errest,PETSC_NULL,0);
#else
info = lobpcg_solve_double(blopex->eigenvectors,eps,OperatorAMultiVector,
eps->isgeneralized?eps:PETSC_NULL,eps->isgeneralized?OperatorBMultiVector:PETSC_NULL,
eps,Precond_FnMultiVector,blopex->Y,
blopex->blap_fn,blopex->tol,eps->max_it,0,&its,
eps->eigr,PETSC_NULL,0,eps->errest,PETSC_NULL,0);
#endif
if (info>0) SETERRQ1(PETSC_ERR_LIB,"Error in blopex (code=%d)",info);
eps->its = its;
eps->nconv = eps->ncv;
if (info==-1) eps->reason = EPS_DIVERGED_ITS;
else eps->reason = EPS_CONVERGED_TOL;
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSDestroy_BLOPEX"
PetscErrorCode EPSDestroy_BLOPEX(EPS eps)
{
PetscErrorCode ierr;
EPS_BLOPEX *blopex = (EPS_BLOPEX *)eps->data;
PetscFunctionBegin;
LOBPCG_DestroyRandomContext();
SLEPCSetupInterpreterForDignifiedDeath(&blopex->ii);
mv_MultiVectorDestroy(blopex->eigenvectors);
mv_MultiVectorDestroy(blopex->Y);
ierr = PetscFree(eps->data);CHKERRQ(ierr);
ierr = EPSDestroy_Default(eps);CHKERRQ(ierr);
PetscFunctionReturn(0);
}
EXTERN_C_BEGIN
#undef __FUNCT__
#define __FUNCT__ "EPSCreate_BLOPEX"
PetscErrorCode EPSCreate_BLOPEX(EPS eps)
{
PetscErrorCode ierr;
EPS_BLOPEX *blopex;
const char* prefix;
PetscFunctionBegin;
ierr = STSetType(eps->OP, STPRECOND); CHKERRQ(ierr);
ierr = STPrecondSetMatForKSP(eps->OP, PETSC_TRUE); CHKERRQ(ierr);
ierr = PetscNew(EPS_BLOPEX,&blopex);CHKERRQ(ierr);
PetscLogObjectMemory(eps,sizeof(EPS_BLOPEX));
ierr = KSPCreate(((PetscObject)eps)->comm,&blopex->ksp);CHKERRQ(ierr);
ierr = EPSGetOptionsPrefix(eps,&prefix);CHKERRQ(ierr);
ierr = KSPSetOptionsPrefix(blopex->ksp,prefix);CHKERRQ(ierr);
ierr = KSPAppendOptionsPrefix(blopex->ksp,"eps_blopex_");CHKERRQ(ierr);
eps->data = (void *) blopex;
eps->ops->setup = EPSSetUp_BLOPEX;
eps->ops->setfromoptions = PETSC_NULL;
eps->ops->destroy = EPSDestroy_BLOPEX;
eps->ops->backtransform = EPSBackTransform_Default;
eps->ops->computevectors = EPSComputeVectors_Default;
PetscFunctionReturn(0);
}
EXTERN_C_END