/*
The basic EPS routines, Create, View, etc. are here.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
SLEPc - Scalable Library for Eigenvalue Problem Computations
Copyright (c) 2002-2010, 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/epsimpl.h> /*I "slepceps.h" I*/
PetscFList EPSList = 0;
PetscBool EPSRegisterAllCalled = PETSC_FALSE;
PetscClassId EPS_CLASSID = 0;
PetscLogEvent EPS_SetUp = 0,EPS_Solve = 0,EPS_Dense = 0;
static PetscBool EPSPackageInitialized = PETSC_FALSE;
const char *EPSPowerShiftTypes[] = {"CONSTANT","RAYLEIGH","WILKINSON","EPSPowerShiftType","EPS_POWER_SHIFT_",0};
const char *EPSLanczosReorthogTypes[] = {"LOCAL","FULL","SELECTIVE","PERIODIC","PARTIAL","DELAYED","EPSLanczosReorthogType","EPS_LANCZOS_REORTHOG_",0};
const char *EPSPRIMMEMethods[] = {"DYNAMIC","DEFAULT_MIN_TIME","DEFAULT_MIN_MATVECS","ARNOLDI","GD","GD_PLUSK","GD_OLSEN_PLUSK","JD_OLSEN_PLUSK","RQI","JDQR","JDQMR","JDQMR_ETOL","SUBSPACE_ITERATION","LOBPCG_ORTHOBASIS","LOBPCG_ORTHOBASISW","EPSPRIMMEMethod","EPS_PRIMME_",0};
#undef __FUNCT__
#define __FUNCT__ "EPSFinalizePackage"
/*@C
EPSFinalizePackage - This function destroys everything in the Slepc interface to the EPS package. It is
called from SlepcFinalize().
Level: developer
.seealso: SlepcFinalize()
@*/
PetscErrorCode EPSFinalizePackage(void)
{
PetscFunctionBegin;
EPSPackageInitialized = PETSC_FALSE;
EPSList = 0;
EPSRegisterAllCalled = PETSC_FALSE;
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSInitializePackage"
/*@C
EPSInitializePackage - This function initializes everything in the EPS package. It is called
from PetscDLLibraryRegister() when using dynamic libraries, and on the first call to EPSCreate()
when using static libraries.
Input Parameter:
path - The dynamic library path, or PETSC_NULL
Level: developer
.seealso: SlepcInitialize()
@*/
PetscErrorCode EPSInitializePackage(const char *path) {
char logList[256];
char *className;
PetscBool opt;
PetscErrorCode ierr;
PetscFunctionBegin;
if (EPSPackageInitialized) PetscFunctionReturn(0);
EPSPackageInitialized = PETSC_TRUE;
/* Register Classes */
ierr = PetscClassIdRegister("Eigenproblem Solver",&EPS_CLASSID);CHKERRQ(ierr);
/* Register Constructors */
ierr = EPSRegisterAll(path);CHKERRQ(ierr);
/* Register Events */
ierr = PetscLogEventRegister("EPSSetUp",EPS_CLASSID,&EPS_SetUp);CHKERRQ(ierr);
ierr = PetscLogEventRegister("EPSSolve",EPS_CLASSID,&EPS_Solve);CHKERRQ(ierr);
ierr = PetscLogEventRegister("EPSDense",EPS_CLASSID,&EPS_Dense);CHKERRQ(ierr);
/* Process info exclusions */
ierr = PetscOptionsGetString(PETSC_NULL,"-info_exclude",logList,256,&opt);CHKERRQ(ierr);
if (opt) {
ierr = PetscStrstr(logList,"eps",&className);CHKERRQ(ierr);
if (className) {
ierr = PetscInfoDeactivateClass(EPS_CLASSID);CHKERRQ(ierr);
}
}
/* Process summary exclusions */
ierr = PetscOptionsGetString(PETSC_NULL,"-log_summary_exclude",logList,256,&opt);CHKERRQ(ierr);
if (opt) {
ierr = PetscStrstr(logList,"eps",&className);CHKERRQ(ierr);
if (className) {
ierr = PetscLogEventDeactivateClass(EPS_CLASSID);CHKERRQ(ierr);
}
}
ierr = PetscRegisterFinalize(EPSFinalizePackage);CHKERRQ(ierr);
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSView"
/*@C
EPSView - Prints the EPS data structure.
Collective on EPS
Input Parameters:
+ eps - the eigenproblem solver context
- viewer - optional visualization context
Options Database Key:
. -eps_view - Calls EPSView() at end of EPSSolve()
Note:
The available visualization contexts include
+ PETSC_VIEWER_STDOUT_SELF - standard output (default)
- PETSC_VIEWER_STDOUT_WORLD - synchronized standard
output where only the first processor opens
the file. All other processors send their
data to the first processor to print.
The user can open an alternative visualization context with
PetscViewerASCIIOpen() - output to a specified file.
Level: beginner
.seealso: STView(), PetscViewerASCIIOpen()
@*/
PetscErrorCode EPSView(EPS eps,PetscViewer viewer)
{
PetscErrorCode ierr;
const char *type,*extr,*bal;
PetscBool isascii;
PetscFunctionBegin;
PetscValidHeaderSpecific(eps,EPS_CLASSID,1);
if (!viewer) viewer = PETSC_VIEWER_STDOUT_(((PetscObject)eps)->comm);
PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
PetscCheckSameComm(eps,1,viewer,2);
#if defined(PETSC_USE_COMPLEX)
#define HERM "hermitian"
#else
#define HERM "symmetric"
#endif
ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr);
if (isascii) {
ierr = PetscObjectPrintClassNamePrefixType((PetscObject)eps,viewer,"EPS Object");CHKERRQ(ierr);
if (eps->ops->view) {
ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
ierr = (*eps->ops->view)(eps,viewer);CHKERRQ(ierr);
ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
}
if (eps->problem_type) {
switch (eps->problem_type) {
case EPS_HEP: type = HERM " eigenvalue problem"; break;
case EPS_GHEP: type = "generalized " HERM " eigenvalue problem"; break;
case EPS_NHEP: type = "non-" HERM " eigenvalue problem"; break;
case EPS_GNHEP: type = "generalized non-" HERM " eigenvalue problem"; break;
case EPS_PGNHEP: type = "generalized non-" HERM " eigenvalue problem with " HERM " positive definite B"; break;
case EPS_GHIEP: type = "generalized " HERM "-indefinite eigenvalue problem"; break;
default: SETERRQ(((PetscObject)eps)->comm,1,"Wrong value of eps->problem_type");
}
} else type = "not yet set";
ierr = PetscViewerASCIIPrintf(viewer," problem type: %s\n",type);CHKERRQ(ierr);
if (eps->extraction) {
switch (eps->extraction) {
case EPS_RITZ: extr = "Rayleigh-Ritz"; break;
case EPS_HARMONIC: extr = "harmonic Ritz"; break;
case EPS_HARMONIC_RELATIVE:extr = "relative harmonic Ritz"; break;
case EPS_HARMONIC_RIGHT: extr = "right harmonic Ritz"; break;
case EPS_HARMONIC_LARGEST: extr = "largest harmonic Ritz"; break;
case EPS_REFINED: extr = "refined Ritz"; break;
case EPS_REFINED_HARMONIC: extr = "refined harmonic Ritz"; break;
default: SETERRQ(((PetscObject)eps)->comm,1,"Wrong value of eps->extraction");
}
ierr = PetscViewerASCIIPrintf(viewer," extraction type: %s\n",extr);CHKERRQ(ierr);
}
if (eps->balance && !eps->ishermitian && eps->balance!=EPS_BALANCE_NONE) {
switch (eps->balance) {
case EPS_BALANCE_ONESIDE: bal = "one-sided Krylov"; break;
case EPS_BALANCE_TWOSIDE: bal = "two-sided Krylov"; break;
case EPS_BALANCE_USER: bal = "user-defined matrix"; break;
default: SETERRQ(((PetscObject)eps)->comm,1,"Wrong value of eps->balance");
}
ierr = PetscViewerASCIIPrintf(viewer," balancing enabled: %s",bal);CHKERRQ(ierr);
if (eps->balance==EPS_BALANCE_ONESIDE || eps->balance==EPS_BALANCE_TWOSIDE) {
ierr = PetscViewerASCIIPrintf(viewer,", with its=%D",eps->balance_its);CHKERRQ(ierr);
}
if (eps->balance==EPS_BALANCE_TWOSIDE && eps->balance_cutoff!=0.0) {
ierr = PetscViewerASCIIPrintf(viewer," and cutoff=%G",eps->balance_cutoff);CHKERRQ(ierr);
}
ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
}
ierr = PetscViewerASCIIPrintf(viewer," selected portion of the spectrum: ");CHKERRQ(ierr);
if (!eps->which) {
ierr = PetscViewerASCIIPrintf(viewer,"not yet set\n");CHKERRQ(ierr);
} else switch (eps->which) {
case EPS_WHICH_USER:
ierr = PetscViewerASCIIPrintf(viewer,"user defined\n");CHKERRQ(ierr);
break;
case EPS_TARGET_MAGNITUDE:
#if !defined(PETSC_USE_COMPLEX)
ierr = PetscViewerASCIIPrintf(viewer,"closest to target: %G (in magnitude)\n",eps->target);CHKERRQ(ierr);
#else
ierr = PetscViewerASCIIPrintf(viewer,"closest to target: %G+%G i (in magnitude)\n",PetscRealPart(eps->target),PetscImaginaryPart(eps->target));CHKERRQ(ierr);
#endif
break;
case EPS_TARGET_REAL:
#if !defined(PETSC_USE_COMPLEX)
ierr = PetscViewerASCIIPrintf(viewer,"closest to target: %G (along the real axis)\n",eps->target);CHKERRQ(ierr);
#else
ierr = PetscViewerASCIIPrintf(viewer,"closest to target: %G+%G i (along the real axis)\n",PetscRealPart(eps->target),PetscImaginaryPart(eps->target));CHKERRQ(ierr);
#endif
break;
#if defined(PETSC_USE_COMPLEX)
case EPS_TARGET_IMAGINARY:
ierr = PetscViewerASCIIPrintf(viewer,"closest to target: %G+%G i (along the imaginary axis)\n",PetscRealPart(eps->target),PetscImaginaryPart(eps->target));CHKERRQ(ierr);
break;
#endif
case EPS_LARGEST_MAGNITUDE:
ierr = PetscViewerASCIIPrintf(viewer,"largest eigenvalues in magnitude\n");CHKERRQ(ierr);
break;
case EPS_SMALLEST_MAGNITUDE:
ierr = PetscViewerASCIIPrintf(viewer,"smallest eigenvalues in magnitude\n");CHKERRQ(ierr);
break;
case EPS_LARGEST_REAL:
ierr = PetscViewerASCIIPrintf(viewer,"largest real parts\n");CHKERRQ(ierr);
break;
case EPS_SMALLEST_REAL:
ierr = PetscViewerASCIIPrintf(viewer,"smallest real parts\n");CHKERRQ(ierr);
break;
case EPS_LARGEST_IMAGINARY:
ierr = PetscViewerASCIIPrintf(viewer,"largest imaginary parts\n");CHKERRQ(ierr);
break;
case EPS_SMALLEST_IMAGINARY:
ierr = PetscViewerASCIIPrintf(viewer,"smallest imaginary parts\n");CHKERRQ(ierr);
break;
case EPS_ALL:
ierr = PetscViewerASCIIPrintf(viewer,"all eigenvalues in interval [%g,%g]\n",eps->inta,eps->intb);CHKERRQ(ierr);
break;
default: SETERRQ(((PetscObject)eps)->comm,1,"Wrong value of eps->which");
}
if (eps->leftvecs) {
ierr = PetscViewerASCIIPrintf(viewer," computing left eigenvectors also\n");CHKERRQ(ierr);
}
if (eps->trueres) {
ierr = PetscViewerASCIIPrintf(viewer," computing true residuals explicitly\n");CHKERRQ(ierr);
}
if (eps->trackall) {
ierr = PetscViewerASCIIPrintf(viewer," computing all residuals (for tracking convergence)\n");CHKERRQ(ierr);
}
ierr = PetscViewerASCIIPrintf(viewer," number of eigenvalues (nev): %D\n",eps->nev);CHKERRQ(ierr);
ierr = PetscViewerASCIIPrintf(viewer," number of column vectors (ncv): %D\n",eps->ncv);CHKERRQ(ierr);
ierr = PetscViewerASCIIPrintf(viewer," maximum dimension of projected problem (mpd): %d\n",eps->mpd);CHKERRQ(ierr);
ierr = PetscViewerASCIIPrintf(viewer," maximum number of iterations: %D\n",eps->max_it);
ierr = PetscViewerASCIIPrintf(viewer," tolerance: %G\n",eps->tol);CHKERRQ(ierr);
ierr = PetscViewerASCIIPrintf(viewer," convergence test: ");CHKERRQ(ierr);
switch(eps->conv) {
case EPS_CONV_ABS:
ierr = PetscViewerASCIIPrintf(viewer,"absolute\n");CHKERRQ(ierr);break;
case EPS_CONV_EIG:
ierr = PetscViewerASCIIPrintf(viewer,"relative to the eigenvalue\n");CHKERRQ(ierr);break;
case EPS_CONV_NORM:
ierr = PetscViewerASCIIPrintf(viewer,"relative to the eigenvalue and matrix norms\n");CHKERRQ(ierr);break;
default:
ierr = PetscViewerASCIIPrintf(viewer,"user-defined\n");CHKERRQ(ierr);break;
}
if (eps->nini!=0) {
ierr = PetscViewerASCIIPrintf(viewer," dimension of user-provided initial space: %D\n",PetscAbs(eps->nini));CHKERRQ(ierr);
}
if (eps->ninil!=0) {
ierr = PetscViewerASCIIPrintf(viewer," dimension of user-provided initial left space: %D\n",PetscAbs(eps->ninil));CHKERRQ(ierr);
}
if (eps->nds>0) {
ierr = PetscViewerASCIIPrintf(viewer," dimension of user-provided deflation space: %D\n",eps->nds);CHKERRQ(ierr);
}
ierr = PetscViewerASCIIPrintf(viewer," estimates of matrix norms (%s): norm(A)=%G",eps->adaptive?"adaptive":"constant",eps->nrma);CHKERRQ(ierr);
if (eps->isgeneralized) {
ierr = PetscViewerASCIIPrintf(viewer,", norm(B)=%G",eps->nrmb);CHKERRQ(ierr);
}
ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
} else {
if (eps->ops->view) {
ierr = (*eps->ops->view)(eps,viewer);CHKERRQ(ierr);
}
}
if (!eps->ip) { ierr = EPSGetIP(eps,&eps->ip);CHKERRQ(ierr); }
ierr = IPView(eps->ip,viewer);CHKERRQ(ierr);
if (!eps->OP) { ierr = EPSGetST(eps,&eps->OP);CHKERRQ(ierr); }
ierr = STView(eps->OP,viewer);CHKERRQ(ierr);
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSCreate"
/*@C
EPSCreate - Creates the default EPS context.
Collective on MPI_Comm
Input Parameter:
. comm - MPI communicator
Output Parameter:
. eps - location to put the EPS context
Note:
The default EPS type is EPSKRYLOVSCHUR
Level: beginner
.seealso: EPSSetUp(), EPSSolve(), EPSDestroy(), EPS
@*/
PetscErrorCode EPSCreate(MPI_Comm comm,EPS *outeps)
{
PetscErrorCode ierr;
EPS eps;
PetscFunctionBegin;
PetscValidPointer(outeps,2);
*outeps = 0;
ierr = PetscHeaderCreate(eps,_p_EPS,struct _EPSOps,EPS_CLASSID,-1,"EPS","Eigenvalue Problem Solver","EPS",comm,EPSDestroy,EPSView);CHKERRQ(ierr);
eps->max_it = 0;
eps->nev = 1;
eps->ncv = 0;
eps->mpd = 0;
eps->allocated_ncv = 0;
eps->nini = 0;
eps->ninil = 0;
eps->nds = 0;
eps->tol = 1e-7;
eps->conv = EPS_CONV_EIG;
eps->conv_func = EPSEigRelativeConverged;
eps->conv_ctx = PETSC_NULL;
eps->which = (EPSWhich)0;
eps->which_func = PETSC_NULL;
eps->which_ctx = PETSC_NULL;
eps->leftvecs = PETSC_FALSE;
eps->trueres = PETSC_FALSE;
eps->trackall = PETSC_FALSE;
eps->target = 0.0;
eps->inta = 0.0;
eps->intb = 0.0;
eps->evecsavailable = PETSC_FALSE;
eps->problem_type = (EPSProblemType)0;
eps->extraction = (EPSExtraction)0;
eps->balance = (EPSBalance)0;
eps->balance_its = 5;
eps->balance_cutoff = 1e-8;
eps->nrma = 1.0;
eps->nrmb = 1.0;
eps->adaptive = PETSC_FALSE;
eps->V = 0;
eps->W = 0;
eps->T = 0;
eps->D = 0;
eps->DS = 0;
eps->IS = 0;
eps->ISL = 0;
eps->t = 0;
eps->ds_ortho = PETSC_FALSE;
eps->eigr = 0;
eps->eigi = 0;
eps->errest = 0;
eps->errest_left = 0;
eps->OP = 0;
eps->ip = 0;
eps->rand = 0;
eps->data = 0;
eps->nconv = 0;
eps->its = 0;
eps->perm = PETSC_NULL;
eps->nwork = 0;
eps->work = 0;
eps->isgeneralized = PETSC_FALSE;
eps->ishermitian = PETSC_FALSE;
eps->ispositive = PETSC_FALSE;
eps->setupcalled = 0;
eps->reason = EPS_CONVERGED_ITERATING;
eps->numbermonitors = 0;
ierr = PetscRandomCreate(comm,&eps->rand);CHKERRQ(ierr);
ierr = PetscLogObjectParent(eps,eps->rand);CHKERRQ(ierr);
*outeps = eps;
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSSetType"
/*@C
EPSSetType - Selects the particular solver to be used in the EPS object.
Logically Collective on EPS
Input Parameters:
+ eps - the eigensolver context
- type - a known method
Options Database Key:
. -eps_type <method> - Sets the method; use -help for a list
of available methods
Notes:
See "slepc/include/slepceps.h" for available methods. The default
is EPSKRYLOVSCHUR.
Normally, it is best to use the EPSSetFromOptions() command and
then set the EPS type from the options database rather than by using
this routine. Using the options database provides the user with
maximum flexibility in evaluating the different available methods.
The EPSSetType() routine is provided for those situations where it
is necessary to set the iterative solver independently of the command
line or options database.
Level: intermediate
.seealso: STSetType(), EPSType
@*/
PetscErrorCode EPSSetType(EPS eps,const EPSType type)
{
PetscErrorCode ierr,(*r)(EPS);
PetscBool match;
PetscFunctionBegin;
PetscValidHeaderSpecific(eps,EPS_CLASSID,1);
PetscValidCharPointer(type,2);
ierr = PetscTypeCompare((PetscObject)eps,type,&match);CHKERRQ(ierr);
if (match) PetscFunctionReturn(0);
ierr = PetscFListFind(EPSList,((PetscObject)eps)->comm,type,PETSC_TRUE,(void (**)(void)) &r);CHKERRQ(ierr);
if (!r) SETERRQ1(((PetscObject)eps)->comm,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown EPS type given: %s",type);
if (eps->ops->destroy) { ierr = (*eps->ops->destroy)(eps);CHKERRQ(ierr); }
ierr = PetscMemzero(eps->ops,sizeof(struct _EPSOps));CHKERRQ(ierr);
eps->setupcalled = 0;
ierr = PetscObjectChangeTypeName((PetscObject)eps,type);CHKERRQ(ierr);
ierr = (*r)(eps);CHKERRQ(ierr);
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSGetType"
/*@C
EPSGetType - Gets the EPS type as a string from the EPS object.
Not Collective
Input Parameter:
. eps - the eigensolver context
Output Parameter:
. name - name of EPS method
Level: intermediate
.seealso: EPSSetType()
@*/
PetscErrorCode EPSGetType(EPS eps,const EPSType *type)
{
PetscFunctionBegin;
PetscValidHeaderSpecific(eps,EPS_CLASSID,1);
PetscValidPointer(type,2);
*type = ((PetscObject)eps)->type_name;
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSRegister"
/*@C
EPSRegister - See EPSRegisterDynamic()
Level: advanced
@*/
PetscErrorCode EPSRegister(const char *sname,const char *path,const char *name,PetscErrorCode (*function)(EPS))
{
PetscErrorCode ierr;
char fullname[PETSC_MAX_PATH_LEN];
PetscFunctionBegin;
ierr = PetscFListConcat(path,name,fullname);CHKERRQ(ierr);
ierr = PetscFListAdd(&EPSList,sname,fullname,(void (*)(void))function);CHKERRQ(ierr);
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSRegisterDestroy"
/*@
EPSRegisterDestroy - Frees the list of EPS methods that were
registered by EPSRegisterDynamic().
Not Collective
Level: advanced
.seealso: EPSRegisterDynamic(), EPSRegisterAll()
@*/
PetscErrorCode EPSRegisterDestroy(void)
{
PetscErrorCode ierr;
PetscFunctionBegin;
ierr = PetscFListDestroy(&EPSList);CHKERRQ(ierr);
EPSRegisterAllCalled = PETSC_FALSE;
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSReset"
/*@
EPSReset - Resets the EPS context to the setupcalled=0 state and removes any
allocated objects.
Collective on EPS
Input Parameter:
. eps - eigensolver context obtained from EPSCreate()
Level: advanced
.seealso: EPSDestroy()
@*/
PetscErrorCode EPSReset(EPS eps)
{
PetscErrorCode ierr;
PetscFunctionBegin;
PetscValidHeaderSpecific(eps,EPS_CLASSID,1);
if (eps->ops->reset) { ierr = (eps->ops->reset)(eps);CHKERRQ(ierr); }
if (eps->OP) { ierr = STReset(eps->OP);CHKERRQ(ierr); }
if (eps->ip) { ierr = IPReset(eps->ip);CHKERRQ(ierr); }
ierr = VecDestroy(&eps->t);CHKERRQ(ierr);
ierr = VecDestroy(&eps->D);CHKERRQ(ierr);
eps->setupcalled = 0;
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSDestroy"
/*@C
EPSDestroy - Destroys the EPS context.
Collective on EPS
Input Parameter:
. eps - eigensolver context obtained from EPSCreate()
Level: beginner
.seealso: EPSCreate(), EPSSetUp(), EPSSolve()
@*/
PetscErrorCode EPSDestroy(EPS *eps)
{
PetscErrorCode ierr;
PetscFunctionBegin;
if (!*eps) PetscFunctionReturn(0);
PetscValidHeaderSpecific(*eps,EPS_CLASSID,1);
if (--((PetscObject)(*eps))->refct > 0) { *eps = 0; PetscFunctionReturn(0); }
ierr = EPSReset(*eps);CHKERRQ(ierr);
ierr = PetscObjectDepublish(*eps);CHKERRQ(ierr);
if ((*eps)->ops->destroy) { ierr = (*(*eps)->ops->destroy)(*eps);CHKERRQ(ierr); }
ierr = STDestroy(&(*eps)->OP);CHKERRQ(ierr);
ierr = IPDestroy(&(*eps)->ip);CHKERRQ(ierr);
ierr = PetscRandomDestroy(&(*eps)->rand);CHKERRQ(ierr);
ierr = EPSRemoveDeflationSpace(*eps);CHKERRQ(ierr);
ierr = EPSMonitorCancel(*eps);CHKERRQ(ierr);
ierr = PetscHeaderDestroy(eps);CHKERRQ(ierr);
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSSetTarget"
/*@
EPSSetTarget - Sets the value of the target.
Logically Collective on EPS
Input Parameters:
+ eps - eigensolver context
- target - the value of the target
Notes:
The target is a scalar value used to determine the portion of the spectrum
of interest. It is used in combination with EPSSetWhichEigenpairs().
Level: beginner
.seealso: EPSGetTarget(), EPSSetWhichEigenpairs()
@*/
PetscErrorCode EPSSetTarget(EPS eps,PetscScalar target)
{
PetscErrorCode ierr;
PetscFunctionBegin;
PetscValidHeaderSpecific(eps,EPS_CLASSID,1);
PetscValidLogicalCollectiveScalar(eps,target,2);
eps->target = target;
if (!eps->OP) { ierr = EPSGetST(eps,&eps->OP);CHKERRQ(ierr); }
ierr = STSetDefaultShift(eps->OP,target);CHKERRQ(ierr);
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSGetTarget"
/*@
EPSGetTarget - Gets the value of the target.
Not Collective
Input Parameter:
. eps - eigensolver context
Output Parameter:
. target - the value of the target
Level: beginner
Note:
If the target was not set by the user, then zero is returned.
.seealso: EPSSetTarget()
@*/
PetscErrorCode EPSGetTarget(EPS eps,PetscScalar* target)
{
PetscFunctionBegin;
PetscValidHeaderSpecific(eps,EPS_CLASSID,1);
PetscValidScalarPointer(target,2);
*target = eps->target;
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSSetInterval"
/*@
EPSSetInterval - Defines the computational interval for spectrum slicing.
Logically Collective on EPS
Input Parameters:
+ eps - eigensolver context
. inta - left end of the interval
- intb - right end of the interval
Options Database Key:
. -eps_interval <a,b> - set [a,b] as the interval of interest
Notes:
Spectrum slicing is a technique employed for computing all eigenvalues of
symmetric eigenproblems in a given interval. This function provides the
interval to be considered. It must be used in combination with EPS_ALL, see
EPSSetWhichEigenpairs().
In the command-line option, two values must be provided. For an open interval,
one can give an infinite, e.g., -eps_interval 1.0,inf or -eps_interval -inf,1.0.
An open interval in the programmatic intervace can be specified with
PETSC_MAX_REAL and -PETSC_MAX_REAL.
Level: intermediate
.seealso: EPSGetInterval(), EPSSetWhichEigenpairs()
@*/
PetscErrorCode EPSSetInterval(EPS eps,PetscReal inta,PetscReal intb)
{
PetscFunctionBegin;
PetscValidHeaderSpecific(eps,EPS_CLASSID,1);
PetscValidLogicalCollectiveReal(eps,inta,2);
PetscValidLogicalCollectiveReal(eps,intb,3);
if (inta>=intb) SETERRQ(((PetscObject)eps)->comm,PETSC_ERR_ARG_WRONG,"Badly defined interval, must be inta<intb");
eps->inta = inta;
eps->intb = intb;
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSGetInterval"
/*@
EPSGetInterval - Gets the computational interval for spectrum slicing.
Not Collective
Input Parameter:
. eps - eigensolver context
Output Parameters:
+ inta - left end of the interval
- intb - right end of the interval
Level: intermediate
Note:
If the interval was not set by the user, then zeros are returned.
.seealso: EPSSetInterval()
@*/
PetscErrorCode EPSGetInterval(EPS eps,PetscReal* inta,PetscReal* intb)
{
PetscFunctionBegin;
PetscValidHeaderSpecific(eps,EPS_CLASSID,1);
PetscValidPointer(inta,2);
PetscValidPointer(intb,3);
if (inta) *inta = eps->inta;
if (intb) *intb = eps->intb;
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSSetST"
/*@
EPSSetST - Associates a spectral transformation object to the eigensolver.
Collective on EPS
Input Parameters:
+ eps - eigensolver context obtained from EPSCreate()
- st - the spectral transformation object
Note:
Use EPSGetST() to retrieve the spectral transformation context (for example,
to free it at the end of the computations).
Level: developer
.seealso: EPSGetST()
@*/
PetscErrorCode EPSSetST(EPS eps,ST st)
{
PetscErrorCode ierr;
PetscFunctionBegin;
PetscValidHeaderSpecific(eps,EPS_CLASSID,1);
PetscValidHeaderSpecific(st,ST_CLASSID,2);
PetscCheckSameComm(eps,1,st,2);
ierr = PetscObjectReference((PetscObject)st);CHKERRQ(ierr);
ierr = STDestroy(&eps->OP);CHKERRQ(ierr);
eps->OP = st;
ierr = PetscLogObjectParent(eps,eps->OP);CHKERRQ(ierr);
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSGetST"
/*@C
EPSGetST - Obtain the spectral transformation (ST) object associated
to the eigensolver object.
Not Collective
Input Parameters:
. eps - eigensolver context obtained from EPSCreate()
Output Parameter:
. st - spectral transformation context
Level: beginner
.seealso: EPSSetST()
@*/
PetscErrorCode EPSGetST(EPS eps,ST *st)
{
PetscErrorCode ierr;
PetscFunctionBegin;
PetscValidHeaderSpecific(eps,EPS_CLASSID,1);
PetscValidPointer(st,2);
if (!eps->OP) {
ierr = STCreate(((PetscObject)eps)->comm,&eps->OP);CHKERRQ(ierr);
ierr = PetscLogObjectParent(eps,eps->OP);CHKERRQ(ierr);
}
*st = eps->OP;
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSSetIP"
/*@
EPSSetIP - Associates an inner product object to the eigensolver.
Collective on EPS
Input Parameters:
+ eps - eigensolver context obtained from EPSCreate()
- ip - the inner product object
Note:
Use EPSGetIP() to retrieve the inner product context (for example,
to free it at the end of the computations).
Level: advanced
.seealso: EPSGetIP()
@*/
PetscErrorCode EPSSetIP(EPS eps,IP ip)
{
PetscErrorCode ierr;
PetscFunctionBegin;
PetscValidHeaderSpecific(eps,EPS_CLASSID,1);
PetscValidHeaderSpecific(ip,IP_CLASSID,2);
PetscCheckSameComm(eps,1,ip,2);
ierr = PetscObjectReference((PetscObject)ip);CHKERRQ(ierr);
ierr = IPDestroy(&eps->ip);CHKERRQ(ierr);
eps->ip = ip;
ierr = PetscLogObjectParent(eps,eps->ip);CHKERRQ(ierr);
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSGetIP"
/*@C
EPSGetIP - Obtain the inner product object associated to the eigensolver object.
Not Collective
Input Parameters:
. eps - eigensolver context obtained from EPSCreate()
Output Parameter:
. ip - inner product context
Level: advanced
.seealso: EPSSetIP()
@*/
PetscErrorCode EPSGetIP(EPS eps,IP *ip)
{
PetscErrorCode ierr;
PetscFunctionBegin;
PetscValidHeaderSpecific(eps,EPS_CLASSID,1);
PetscValidPointer(ip,2);
if (!eps->ip) {
ierr = IPCreate(((PetscObject)eps)->comm,&eps->ip);CHKERRQ(ierr);
ierr = PetscLogObjectParent(eps,eps->ip);CHKERRQ(ierr);
}
*ip = eps->ip;
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSIsGeneralized"
/*@
EPSIsGeneralized - Ask if the EPS object corresponds to a generalized
eigenvalue problem.
Not collective
Input Parameter:
. eps - the eigenproblem solver context
Output Parameter:
. is - the answer
Level: intermediate
.seealso: EPSIsHermitian()
@*/
PetscErrorCode EPSIsGeneralized(EPS eps,PetscBool* is)
{
PetscFunctionBegin;
PetscValidHeaderSpecific(eps,EPS_CLASSID,1);
*is = eps->isgeneralized;
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "EPSIsHermitian"
/*@
EPSIsHermitian - Ask if the EPS object corresponds to a Hermitian
eigenvalue problem.
Not collective
Input Parameter:
. eps - the eigenproblem solver context
Output Parameter:
. is - the answer
Level: intermediate
.seealso: EPSIsGeneralized()
@*/
PetscErrorCode EPSIsHermitian(EPS eps,PetscBool* is)
{
PetscFunctionBegin;
PetscValidHeaderSpecific(eps,EPS_CLASSID,1);
*is = eps->ishermitian;
PetscFunctionReturn(0);
}