/*
The basic SVD routines, Create, View, etc. are here.
*/
#include "src/svd/svdimpl.h" /*I "slepcsvd.h" I*/
PetscFList SVDList = 0;
PetscCookie SVD_COOKIE = 0;
PetscEvent SVD_SetUp = 0, SVD_Solve = 0;
#undef __FUNCT__
#define __FUNCT__ "SVDInitializePackage"
/*@C
SVDInitializePackage - This function initializes everything in the SVD package. It is called
from PetscDLLibraryRegister() when using dynamic libraries, and on the first call to SVDCreate()
when using static libraries.
Input Parameter:
path - The dynamic library path, or PETSC_NULL
Level: developer
.seealso: SlepcInitialize()
@*/
PetscErrorCode SVDInitializePackage(char *path)
{
static PetscTruth initialized = PETSC_FALSE;
char logList[256];
char *className;
PetscTruth opt;
PetscErrorCode ierr;
PetscFunctionBegin;
if (initialized) PetscFunctionReturn(0);
initialized = PETSC_TRUE;
/* Register Classes */
ierr = PetscLogClassRegister(&SVD_COOKIE,"Singular Value Solver");CHKERRQ(ierr);
/* Register Constructors */
ierr = SVDRegisterAll(path);CHKERRQ(ierr);
/* Register Events */
ierr = PetscLogEventRegister(&SVD_SetUp,"SVDSetUp",SVD_COOKIE);CHKERRQ(ierr);
ierr = PetscLogEventRegister(&SVD_Solve,"SVDSolve",SVD_COOKIE);CHKERRQ(ierr);
/* Process info exclusions */
ierr = PetscOptionsGetString(PETSC_NULL, "-log_info_exclude", logList, 256, &opt);CHKERRQ(ierr);
if (opt) {
ierr = PetscStrstr(logList, "svd", &className);CHKERRQ(ierr);
if (className) {
ierr = PetscInfoDeactivateClass(SVD_COOKIE);CHKERRQ(ierr);
}
}
/* Process summary exclusions */
ierr = PetscOptionsGetString(PETSC_NULL, "-log_summary_exclude", logList, 256, &opt);CHKERRQ(ierr);
if (opt) {
ierr = PetscStrstr(logList, "svd", &className);CHKERRQ(ierr);
if (className) {
ierr = PetscLogEventDeactivateClass(SVD_COOKIE);CHKERRQ(ierr);
}
}
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "SVDView"
/*@C
SVDView - Prints the SVD data structure.
Collective on SVD
Input Parameters:
+ svd - the singular value solver context
- viewer - optional visualization context
Options Database Key:
. -svd_view - Calls SVDView() at end of SVDSolve()
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 SVDView(SVD svd,PetscViewer viewer)
{
PetscErrorCode ierr;
const char *type;
PetscTruth isascii;
PetscFunctionBegin;
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
if (!viewer) viewer = PETSC_VIEWER_STDOUT_(svd->comm);
PetscValidHeaderSpecific(viewer,PETSC_VIEWER_COOKIE,2);
PetscCheckSameComm(svd,1,viewer,2);
ierr = PetscTypeCompare((PetscObject)viewer,PETSC_VIEWER_ASCII,&isascii);CHKERRQ(ierr);
if (isascii) {
ierr = PetscViewerASCIIPrintf(viewer,"SVD Object:\n");CHKERRQ(ierr);
ierr = SVDGetType(svd,&type);CHKERRQ(ierr);
if (type) {
ierr = PetscViewerASCIIPrintf(viewer," method: %s\n",type);CHKERRQ(ierr);
} else {
ierr = PetscViewerASCIIPrintf(viewer," method: not yet set\n");CHKERRQ(ierr);
}
switch (svd->transmode) {
case SVD_TRANSPOSE_EXPLICIT:
ierr = PetscViewerASCIIPrintf(viewer," transpose mode: explicit\n");CHKERRQ(ierr);
break;
case SVD_TRANSPOSE_IMPLICIT:
ierr = PetscViewerASCIIPrintf(viewer," transpose mode: implicit\n");CHKERRQ(ierr);
break;
default:
ierr = PetscViewerASCIIPrintf(viewer," transpose mode: not yet set\n");CHKERRQ(ierr);
}
if (svd->which == SVD_LARGEST) {
ierr = PetscViewerASCIIPrintf(viewer," selected portion of the spectrum: largest\n");CHKERRQ(ierr);
} else {
ierr = PetscViewerASCIIPrintf(viewer," selected portion of the spectrum: smallest\n");CHKERRQ(ierr);
}
ierr = PetscViewerASCIIPrintf(viewer," number of singular values (nsv): %d\n",svd->nsv);CHKERRQ(ierr);
ierr = PetscViewerASCIIPrintf(viewer," number of column vectors (ncv): %d\n",svd->ncv);CHKERRQ(ierr);
ierr = PetscViewerASCIIPrintf(viewer," maximum number of iterations: %d\n",svd->max_it);
ierr = PetscViewerASCIIPrintf(viewer," tolerance: %g\n",svd->tol);CHKERRQ(ierr);
ierr = IPView(svd->ip,viewer);CHKERRQ(ierr);
if (svd->ops->view) {
ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
ierr = (*svd->ops->view)(svd,viewer);CHKERRQ(ierr);
ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
}
} else {
if (svd->ops->view) {
ierr = (*svd->ops->view)(svd,viewer);CHKERRQ(ierr);
}
}
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "SVDPublish_Petsc"
static PetscErrorCode SVDPublish_Petsc(PetscObject object)
{
PetscFunctionBegin;
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "SVDCreate"
/*@C
SVDCreate - Creates the default SVD context.
Collective on MPI_Comm
Input Parameter:
. comm - MPI communicator
Output Parameter:
. svd - location to put the SVD context
Note:
The default SVD type is SVDEIGENSOLVER
Level: beginner
.seealso: SVDSetUp(), SVDSolve(), SVDDestroy(), SVD
@*/
PetscErrorCode SVDCreate(MPI_Comm comm,SVD *outsvd)
{
PetscErrorCode ierr;
SVD svd;
PetscFunctionBegin;
PetscValidPointer(outsvd,2);
PetscHeaderCreate(svd,_p_SVD,struct _SVDOps,SVD_COOKIE,-1,"SVD",comm,SVDDestroy,SVDView);
*outsvd = svd;
svd->bops->publish = SVDPublish_Petsc;
ierr = PetscMemzero(svd->ops,sizeof(struct _SVDOps));CHKERRQ(ierr);
svd->type_name = PETSC_NULL;
svd->OP = PETSC_NULL;
svd->A = PETSC_NULL;
svd->AT = PETSC_NULL;
svd->transmode = PETSC_DECIDE;
svd->sigma = PETSC_NULL;
svd->U = PETSC_NULL;
svd->V = PETSC_NULL;
svd->vec_initial = PETSC_NULL;
svd->which = SVD_LARGEST;
svd->n = 0;
svd->nconv = 0;
svd->nsv = 1;
svd->ncv = PETSC_DECIDE;
svd->its = 0;
svd->max_it = PETSC_DECIDE;
svd->tol = 1e-7;
svd->errest = PETSC_NULL;
svd->data = PETSC_NULL;
svd->setupcalled = 0;
svd->reason = SVD_CONVERGED_ITERATING;
svd->numbermonitors = 0;
svd->matvecs = 0;
svd->dots = 0;
ierr = IPCreate(comm,&svd->ip);CHKERRQ(ierr);
PetscLogObjectParent(svd,svd->ip);
ierr = PetscPublishAll(svd);CHKERRQ(ierr);
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "SVDDestroy"
/*@
SVDDestroy - Destroys the SVD context.
Collective on SVD
Input Parameter:
. svd - eigensolver context obtained from SVDCreate()
Level: beginner
.seealso: SVDCreate(), SVDSetUp(), SVDSolve()
@*/
PetscErrorCode SVDDestroy(SVD svd)
{
PetscErrorCode ierr;
int i;
PetscFunctionBegin;
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
if (--svd->refct > 0) PetscFunctionReturn(0);
/* if memory was published with AMS then destroy it */
ierr = PetscObjectDepublish(svd);CHKERRQ(ierr);
if (svd->ops->destroy) {
ierr = (*svd->ops->destroy)(svd); CHKERRQ(ierr);
}
if (svd->OP) { ierr = MatDestroy(svd->OP);CHKERRQ(ierr); }
if (svd->A) { ierr = MatDestroy(svd->A);CHKERRQ(ierr); }
if (svd->AT) { ierr = MatDestroy(svd->AT);CHKERRQ(ierr); }
if (svd->n) {
ierr = PetscFree(svd->sigma);CHKERRQ(ierr);
ierr = PetscFree(svd->errest);CHKERRQ(ierr);
if (svd->U) {
for (i=0;i<svd->n;i++) {
ierr = VecDestroy(svd->U[i]); CHKERRQ(ierr);
}
ierr = PetscFree(svd->U);CHKERRQ(ierr);
}
for (i=0;i<svd->n;i++) {
ierr = VecDestroy(svd->V[i]);CHKERRQ(ierr);
}
ierr = PetscFree(svd->V);CHKERRQ(ierr);
}
if (svd->vec_initial) { ierr = VecDestroy(svd->vec_initial);CHKERRQ(ierr); }
if (svd->data) { ierr = PetscFree(svd->data);CHKERRQ(ierr); }
ierr = SVDClearMonitor(svd);CHKERRQ(ierr);
ierr = IPDestroy(svd->ip);CHKERRQ(ierr);
PetscHeaderDestroy(svd);
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "SVDSetType"
/*@C
SVDSetType - Selects the particular solver to be used in the SVD object.
Collective on SVD
Input Parameters:
+ svd - the singular value solver context
- type - a known method
Options Database Key:
. -svd_type <method> - Sets the method; use -help for a list
of available methods
Notes:
See "slepc/include/slepcsvd.h" for available methods. The default
is SVDEIGENSOLVER.
Normally, it is best to use the SVDSetFromOptions() command and
then set the SVD 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 SVDSetType() 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: SVDType
@*/
PetscErrorCode SVDSetType(SVD svd,SVDType type)
{
PetscErrorCode ierr,(*r)(SVD);
PetscTruth match;
PetscFunctionBegin;
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
PetscValidCharPointer(type,2);
ierr = PetscTypeCompare((PetscObject)svd,type,&match);CHKERRQ(ierr);
if (match) PetscFunctionReturn(0);
if (svd->data) {
/* destroy the old private SVD context */
ierr = (*svd->ops->destroy)(svd); CHKERRQ(ierr);
svd->data = 0;
}
ierr = PetscFListFind(svd->comm,SVDList,type,(void (**)(void)) &r);CHKERRQ(ierr);
if (!r) SETERRQ1(1,"Unknown SVD type given: %s",type);
svd->setupcalled = 0;
ierr = PetscMemzero(svd->ops,sizeof(struct _SVDOps));CHKERRQ(ierr);
ierr = (*r)(svd); CHKERRQ(ierr);
ierr = PetscObjectChangeTypeName((PetscObject)svd,type);CHKERRQ(ierr);
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "SVDGetType"
/*@C
SVDGetType - Gets the SVD type as a string from the SVD object.
Not Collective
Input Parameter:
. svd - the singular value solver context
Output Parameter:
. name - name of SVD method
Level: intermediate
.seealso: SVDSetType()
@*/
PetscErrorCode SVDGetType(SVD svd,SVDType *type)
{
PetscFunctionBegin;
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
*type = svd->type_name;
PetscFunctionReturn(0);
}
/*MC
SVDRegisterDynamic - Adds a method to the singular value solver package.
Synopsis:
SVDRegisterDynamic(char *name_solver,char *path,char *name_create,int (*routine_create)(SVD))
Not Collective
Input Parameters:
+ name_solver - name of a new user-defined solver
. path - path (either absolute or relative) the library containing this solver
. name_create - name of routine to create the solver context
- routine_create - routine to create the solver context
Notes:
SVDRegisterDynamic() may be called multiple times to add several user-defined solvers.
If dynamic libraries are used, then the fourth input argument (routine_create)
is ignored.
Sample usage:
.vb
SVDRegisterDynamic("my_solver",/home/username/my_lib/lib/libO/solaris/mylib.a,
"MySolverCreate",MySolverCreate);
.ve
Then, your solver can be chosen with the procedural interface via
$ SVDSetType(svd,"my_solver")
or at runtime via the option
$ -svd_type my_solver
Level: advanced
Environmental variables such as ${PETSC_ARCH}, ${SLEPC_DIR},
and others of the form ${any_environmental_variable} occuring in pathname will be
replaced with appropriate values.
.seealso: SVDRegisterAll()
M*/
#undef __FUNCT__
#define __FUNCT__ "SVDRegister"
PetscErrorCode SVDRegister(const char *sname,const char *path,const char *name,int (*function)(SVD))
{
PetscErrorCode ierr;
char fullname[256];
PetscFunctionBegin;
ierr = PetscFListConcat(path,name,fullname);CHKERRQ(ierr);
ierr = PetscFListAdd(&SVDList,sname,fullname,(void (*)(void))function);CHKERRQ(ierr);
PetscFunctionReturn(0);
}