/*
|
/*
|
SVD routines for setting solver options.
|
SVD routines for setting solver options.
|
*/
|
*/
|
#include "src/svd/svdimpl.h" /*I "slepcsvd.h" I*/
|
#include "src/svd/svdimpl.h" /*I "slepcsvd.h" I*/
|
|
|
#undef __FUNCT__
|
#undef __FUNCT__
|
#define __FUNCT__ "SVDSetTransposeMode"
|
#define __FUNCT__ "SVDSetTransposeMode"
|
/*@
|
/*@
|
SVDSetTransposeMode - Sets how to handle the transpose of the matrix
|
SVDSetTransposeMode - Sets how to handle the transpose of the matrix
|
associated with the singular value problem.
|
associated with the singular value problem.
|
|
|
Collective on SVD and Mat
|
Collective on SVD and Mat
|
|
|
Input Parameters:
|
Input Parameters:
|
+ svd - the singular value solver context
|
+ svd - the singular value solver context
|
- mode - how to compute the transpose, one of SVD_TRANSPOSE_EXPLICIT
|
- mode - how to compute the transpose, one of SVD_TRANSPOSE_EXPLICIT
|
or SVD_TRANSPOSE_MATMULT (see notes below)
|
or SVD_TRANSPOSE_MATMULT (see notes below)
|
|
|
Options Database Key:
|
Options Database Key:
|
. -svd_transpose_mode <mode> - Indicates the mode flag, where <mode>
|
. -svd_transpose_mode <mode> - Indicates the mode flag, where <mode>
|
is one of 'explicit' or 'matmult'.
|
is one of 'explicit' or 'matmult'.
|
|
|
Notes:
|
Notes:
|
In the SVD_TRANSPOSE_EXPLICIT mode, the transpose of the matrix is
|
In the SVD_TRANSPOSE_EXPLICIT mode, the transpose of the matrix is
|
explicitly built.
|
explicitly built.
|
|
|
The option SVD_TRANSPOSE_MATMULT does not build the transpose, but
|
The option SVD_TRANSPOSE_MATMULT does not build the transpose, but
|
handles it implicitly via MatMultTranspose() operations. This is
|
handles it implicitly via MatMultTranspose() operations. This is
|
likely to be more inefficient than SVD_TRANSPOSE_EXPLICIT, both in
|
likely to be more inefficient than SVD_TRANSPOSE_EXPLICIT, both in
|
sequential and in parallel, but requires less storage.
|
sequential and in parallel, but requires less storage.
|
|
|
The default is SVD_TRANSPOSE_EXPLICIT if the matrix has defined the
|
The default is SVD_TRANSPOSE_EXPLICIT if the matrix has defined the
|
MatTranspose operation, and SVD_TRANSPOSE_MATMULT otherwise.
|
MatTranspose operation, and SVD_TRANSPOSE_MATMULT otherwise.
|
|
|
Level: advanced
|
Level: advanced
|
|
|
.seealso: SVDGetTransposeMode(), SVDSolve(), SVDSetOperator(), SVDGetOperator()
|
.seealso: SVDGetTransposeMode(), SVDSolve(), SVDSetOperator(),
|
|
SVDGetOperator(), SVDTransposeMode
|
@*/
|
@*/
|
PetscErrorCode SVDSetTransposeMode(SVD svd,SVDTransposeMode mode)
|
PetscErrorCode SVDSetTransposeMode(SVD svd,SVDTransposeMode mode)
|
{
|
{
|
PetscFunctionBegin;
|
PetscFunctionBegin;
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
switch (mode) {
|
switch (mode) {
|
case PETSC_DEFAULT:
|
case PETSC_DEFAULT:
|
mode = (SVDTransposeMode)PETSC_DECIDE;
|
mode = (SVDTransposeMode)PETSC_DECIDE;
|
case SVD_TRANSPOSE_EXPLICIT:
|
case SVD_TRANSPOSE_EXPLICIT:
|
case SVD_TRANSPOSE_IMPLICIT:
|
case SVD_TRANSPOSE_IMPLICIT:
|
case PETSC_DECIDE:
|
case PETSC_DECIDE:
|
svd->transmode = mode;
|
svd->transmode = mode;
|
svd->setupcalled = 0;
|
svd->setupcalled = 0;
|
break;
|
break;
|
default:
|
default:
|
SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Invalid transpose mode");
|
SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Invalid transpose mode");
|
}
|
}
|
PetscFunctionReturn(0);
|
PetscFunctionReturn(0);
|
}
|
}
|
|
|
#undef __FUNCT__
|
#undef __FUNCT__
|
#define __FUNCT__ "SVDGetTransposeMode"
|
#define __FUNCT__ "SVDGetTransposeMode"
|
/*@C
|
/*@C
|
SVDGetTransposeMode - Gets the mode use to compute the transpose
|
SVDGetTransposeMode - Gets the mode use to compute the transpose
|
of the matrix associated with the singular value problem.
|
of the matrix associated with the singular value problem.
|
|
|
Not collective
|
Not collective
|
|
|
Input Parameter:
|
Input Parameter:
|
+ svd - the singular value solver context
|
+ svd - the singular value solver context
|
|
|
Output paramter:
|
Output paramter:
|
+ mode - how to compute the transpose, one of SVD_TRANSPOSE_EXPLICIT
|
+ mode - how to compute the transpose, one of SVD_TRANSPOSE_EXPLICIT
|
or SVD_TRANSPOSE_MATMULT
|
or SVD_TRANSPOSE_MATMULT
|
|
|
Level: advanced
|
Level: advanced
|
|
|
.seealso: SVDSetTransposeMode(), SVDSolve(), SVDSetOperator(), SVDGetOperator()
|
.seealso: SVDSetTransposeMode(), SVDSolve(), SVDSetOperator(),
|
|
SVDGetOperator(), SVDTransposeMode
|
@*/
|
@*/
|
PetscErrorCode SVDGetTransposeMode(SVD svd,SVDTransposeMode *mode)
|
PetscErrorCode SVDGetTransposeMode(SVD svd,SVDTransposeMode *mode)
|
{
|
{
|
PetscFunctionBegin;
|
PetscFunctionBegin;
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
PetscValidPointer(mode,2);
|
PetscValidPointer(mode,2);
|
*mode = svd->transmode;
|
*mode = svd->transmode;
|
PetscFunctionReturn(0);
|
PetscFunctionReturn(0);
|
}
|
}
|
|
|
#undef __FUNCT__
|
#undef __FUNCT__
|
#define __FUNCT__ "SVDSetTolerances"
|
#define __FUNCT__ "SVDSetTolerances"
|
/*@
|
/*@
|
SVDSetTolerances - Sets the tolerance and maximum
|
SVDSetTolerances - Sets the tolerance and maximum
|
iteration count used by the default SVD convergence testers.
|
iteration count used by the default SVD convergence testers.
|
|
|
Collective on SVD
|
Collective on SVD
|
|
|
Input Parameters:
|
Input Parameters:
|
+ svd - the singluar value solver context
|
+ svd - the singluar value solver context
|
. tol - the convergence tolerance
|
. tol - the convergence tolerance
|
- maxits - maximum number of iterations to use
|
- maxits - maximum number of iterations to use
|
|
|
Options Database Keys:
|
Options Database Keys:
|
+ -svd_tol <tol> - Sets the convergence tolerance
|
+ -svd_tol <tol> - Sets the convergence tolerance
|
- -svd_max_it <maxits> - Sets the maximum number of iterations allowed
|
- -svd_max_it <maxits> - Sets the maximum number of iterations allowed
|
(use PETSC_DECIDE to compute an educated guess based on basis and matrix sizes)
|
(use PETSC_DECIDE to compute an educated guess based on basis and matrix sizes)
|
|
|
Notes:
|
Notes:
|
Use PETSC_IGNORE to retain the previous value of any parameter.
|
Use PETSC_IGNORE to retain the previous value of any parameter.
|
|
|
Level: intermediate
|
Level: intermediate
|
|
|
.seealso: SVDGetTolerances()
|
.seealso: SVDGetTolerances()
|
@*/
|
@*/
|
PetscErrorCode SVDSetTolerances(SVD svd,PetscReal tol,int maxits)
|
PetscErrorCode SVDSetTolerances(SVD svd,PetscReal tol,int maxits)
|
{
|
{
|
PetscFunctionBegin;
|
PetscFunctionBegin;
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
if (tol != PETSC_IGNORE) {
|
if (tol != PETSC_IGNORE) {
|
if (tol == PETSC_DEFAULT) {
|
if (tol == PETSC_DEFAULT) {
|
tol = 1e-7;
|
tol = 1e-7;
|
} else {
|
} else {
|
if (tol < 0.0) SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Illegal value of tol. Must be > 0");
|
if (tol < 0.0) SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Illegal value of tol. Must be > 0");
|
svd->tol = tol;
|
svd->tol = tol;
|
}
|
}
|
}
|
}
|
if (maxits != PETSC_IGNORE) {
|
if (maxits != PETSC_IGNORE) {
|
if (maxits == PETSC_DEFAULT || maxits == PETSC_DECIDE) {
|
if (maxits == PETSC_DEFAULT || maxits == PETSC_DECIDE) {
|
svd->max_it = PETSC_DECIDE;
|
svd->max_it = PETSC_DECIDE;
|
svd->setupcalled = 0;
|
svd->setupcalled = 0;
|
} else {
|
} else {
|
if (maxits < 0) SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Illegal value of maxits. Must be > 0");
|
if (maxits < 0) SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Illegal value of maxits. Must be > 0");
|
svd->max_it = maxits;
|
svd->max_it = maxits;
|
}
|
}
|
}
|
}
|
PetscFunctionReturn(0);
|
PetscFunctionReturn(0);
|
}
|
}
|
|
|
#undef __FUNCT__
|
#undef __FUNCT__
|
#define __FUNCT__ "SVDGetTolerances"
|
#define __FUNCT__ "SVDGetTolerances"
|
/*@
|
/*@
|
SVDGetTolerances - Gets the tolerance and maximum
|
SVDGetTolerances - Gets the tolerance and maximum
|
iteration count used by the default SVD convergence tests.
|
iteration count used by the default SVD convergence tests.
|
|
|
Not Collective
|
Not Collective
|
|
|
Input Parameter:
|
Input Parameter:
|
. svd - the singular value solver context
|
. svd - the singular value solver context
|
|
|
Output Parameters:
|
Output Parameters:
|
+ tol - the convergence tolerance
|
+ tol - the convergence tolerance
|
- maxits - maximum number of iterations
|
- maxits - maximum number of iterations
|
|
|
Notes:
|
Notes:
|
The user can specify PETSC_NULL for any parameter that is not needed.
|
The user can specify PETSC_NULL for any parameter that is not needed.
|
|
|
Level: intermediate
|
Level: intermediate
|
|
|
.seealso: SVDSetTolerances()
|
.seealso: SVDSetTolerances()
|
@*/
|
@*/
|
PetscErrorCode SVDGetTolerances(SVD svd,PetscReal *tol,int *maxits)
|
PetscErrorCode SVDGetTolerances(SVD svd,PetscReal *tol,int *maxits)
|
{
|
{
|
PetscFunctionBegin;
|
PetscFunctionBegin;
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
if (tol) *tol = svd->tol;
|
if (tol) *tol = svd->tol;
|
if (maxits) *maxits = svd->max_it;
|
if (maxits) *maxits = svd->max_it;
|
PetscFunctionReturn(0);
|
PetscFunctionReturn(0);
|
}
|
}
|
|
|
#undef __FUNCT__
|
#undef __FUNCT__
|
#define __FUNCT__ "SVDSetDimensions"
|
#define __FUNCT__ "SVDSetDimensions"
|
/*@
|
/*@
|
SVDSetDimensions - Sets the number of singular values to compute
|
SVDSetDimensions - Sets the number of singular values to compute
|
and the dimension of the subspace.
|
and the dimension of the subspace.
|
|
|
Collective on SVD
|
Collective on SVD
|
|
|
Input Parameters:
|
Input Parameters:
|
+ svd - the singular value solver context
|
+ svd - the singular value solver context
|
. nsv - number of singular values to compute
|
. nsv - number of singular values to compute
|
- ncv - the maximum dimension of the subspace to be used by the solver
|
- ncv - the maximum dimension of the subspace to be used by the solver
|
|
|
Options Database Keys:
|
Options Database Keys:
|
+ -svd_nsv <nsv> - Sets the number of singular values
|
+ -svd_nsv <nsv> - Sets the number of singular values
|
- -svd_ncv <ncv> - Sets the dimension of the subspace
|
- -svd_ncv <ncv> - Sets the dimension of the subspace
|
|
|
Notes:
|
Notes:
|
Use PETSC_IGNORE to retain the previous value of any parameter.
|
Use PETSC_IGNORE to retain the previous value of any parameter.
|
|
|
Use PETSC_DECIDE for ncv to assign a reasonably good value, which is
|
Use PETSC_DECIDE for ncv to assign a reasonably good value, which is
|
dependent on the solution method and the number of singular values required.
|
dependent on the solution method and the number of singular values required.
|
|
|
Level: intermediate
|
Level: intermediate
|
|
|
.seealso: SVDGetDimensions()
|
.seealso: SVDGetDimensions()
|
@*/
|
@*/
|
PetscErrorCode SVDSetDimensions(SVD svd,int nsv,int ncv)
|
PetscErrorCode SVDSetDimensions(SVD svd,int nsv,int ncv)
|
{
|
{
|
PetscFunctionBegin;
|
PetscFunctionBegin;
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
|
|
if (nsv != PETSC_IGNORE) {
|
if (nsv != PETSC_IGNORE) {
|
if (nsv<1) SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Illegal value of nsv. Must be > 0");
|
if (nsv<1) SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Illegal value of nsv. Must be > 0");
|
svd->nsv = nsv;
|
svd->nsv = nsv;
|
}
|
}
|
if (ncv != PETSC_IGNORE) {
|
if (ncv != PETSC_IGNORE) {
|
if (ncv == PETSC_DEFAULT || ncv == PETSC_DECIDE) {
|
if (ncv == PETSC_DEFAULT || ncv == PETSC_DECIDE) {
|
svd->ncv = PETSC_DECIDE;
|
svd->ncv = PETSC_DECIDE;
|
} else {
|
} else {
|
if (ncv<1) SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Illegal value of ncv. Must be > 0");
|
if (ncv<1) SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Illegal value of ncv. Must be > 0");
|
svd->ncv = ncv;
|
svd->ncv = ncv;
|
}
|
}
|
svd->setupcalled = 0;
|
svd->setupcalled = 0;
|
}
|
}
|
PetscFunctionReturn(0);
|
PetscFunctionReturn(0);
|
}
|
}
|
|
|
#undef __FUNCT__
|
#undef __FUNCT__
|
#define __FUNCT__ "SVDGetDimensions"
|
#define __FUNCT__ "SVDGetDimensions"
|
/*@
|
/*@
|
SVDGetDimensions - Gets the number of singular values to compute
|
SVDGetDimensions - Gets the number of singular values to compute
|
and the dimension of the subspace.
|
and the dimension of the subspace.
|
|
|
Not Collective
|
Not Collective
|
|
|
Input Parameter:
|
Input Parameter:
|
. svd - the singular value context
|
. svd - the singular value context
|
|
|
Output Parameters:
|
Output Parameters:
|
+ nsv - number of singular values to compute
|
+ nsv - number of singular values to compute
|
- ncv - the maximum dimension of the subspace to be used by the solver
|
- ncv - the maximum dimension of the subspace to be used by the solver
|
|
|
Notes:
|
Notes:
|
The user can specify PETSC_NULL for any parameter that is not needed.
|
The user can specify PETSC_NULL for any parameter that is not needed.
|
|
|
Level: intermediate
|
Level: intermediate
|
|
|
.seealso: SVDSetDimensions()
|
.seealso: SVDSetDimensions()
|
@*/
|
@*/
|
PetscErrorCode SVDGetDimensions(SVD svd,int *nsv,int *ncv)
|
PetscErrorCode SVDGetDimensions(SVD svd,int *nsv,int *ncv)
|
{
|
{
|
PetscFunctionBegin;
|
PetscFunctionBegin;
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
if (nsv) *nsv = svd->nsv;
|
if (nsv) *nsv = svd->nsv;
|
if (ncv) *ncv = svd->ncv;
|
if (ncv) *ncv = svd->ncv;
|
PetscFunctionReturn(0);
|
PetscFunctionReturn(0);
|
}
|
}
|
|
|
#undef __FUNCT__
|
#undef __FUNCT__
|
#define __FUNCT__ "SVDSetWhichSingularTriplets"
|
#define __FUNCT__ "SVDSetWhichSingularTriplets"
|
/*@
|
/*@
|
SVDSetWhichSingularTriplets - Specifies which singular triplets are
|
SVDSetWhichSingularTriplets - Specifies which singular triplets are
|
to be sought.
|
to be sought.
|
|
|
Collective on SVD
|
Collective on SVD
|
|
|
Input Parameter:
|
Input Parameter:
|
. svd - singular value solver context obtained from SVDCreate()
|
. svd - singular value solver context obtained from SVDCreate()
|
|
|
Output Parameter:
|
Output Parameter:
|
. which - which singular triplets are to be sought
|
. which - which singular triplets are to be sought
|
|
|
Possible values:
|
Possible values:
|
The parameter 'which' can have one of these values:
|
The parameter 'which' can have one of these values:
|
|
|
+ SVD_LARGEST - largest singular values
|
+ SVD_LARGEST - largest singular values
|
- SVD_SMALLEST - smallest singular values
|
- SVD_SMALLEST - smallest singular values
|
|
|
Options Database Keys:
|
Options Database Keys:
|
+ -svd_largest - Sets largest singular values
|
+ -svd_largest - Sets largest singular values
|
- -svd_smallest - Sets smallest singular values
|
- -svd_smallest - Sets smallest singular values
|
|
|
Level: intermediate
|
Level: intermediate
|
|
|
.seealso: SVDGetWhichSingularTriplets()
|
.seealso: SVDGetWhichSingularTriplets(), SVDWhich
|
@*/
|
@*/
|
PetscErrorCode SVDSetWhichSingularTriplets(SVD svd,SVDWhich which)
|
PetscErrorCode SVDSetWhichSingularTriplets(SVD svd,SVDWhich which)
|
{
|
{
|
PetscFunctionBegin;
|
PetscFunctionBegin;
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
switch (which) {
|
switch (which) {
|
case SVD_LARGEST:
|
case SVD_LARGEST:
|
case SVD_SMALLEST:
|
case SVD_SMALLEST:
|
svd->which = which;
|
svd->which = which;
|
break;
|
break;
|
default:
|
default:
|
SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Invalid 'which' parameter");
|
SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Invalid 'which' parameter");
|
}
|
}
|
PetscFunctionReturn(0);
|
PetscFunctionReturn(0);
|
}
|
}
|
|
|
#undef __FUNCT__
|
#undef __FUNCT__
|
#define __FUNCT__ "SVDGetWhichSingularTriplets"
|
#define __FUNCT__ "SVDGetWhichSingularTriplets"
|
/*@C
|
/*@C
|
SVDGetWhichSingularTriplets - Returns which singular triplets are
|
SVDGetWhichSingularTriplets - Returns which singular triplets are
|
to be sought.
|
to be sought.
|
|
|
Not Collective
|
Not Collective
|
|
|
Input Parameter:
|
Input Parameter:
|
. svd - singular value solver context obtained from SVDCreate()
|
. svd - singular value solver context obtained from SVDCreate()
|
|
|
Output Parameter:
|
Output Parameter:
|
. which - which singular triplets are to be sought
|
. which - which singular triplets are to be sought
|
|
|
Notes:
|
Notes:
|
See SVDSetWhichSingularTriplets() for possible values of which
|
See SVDSetWhichSingularTriplets() for possible values of which
|
|
|
Level: intermediate
|
Level: intermediate
|
|
|
.seealso: SVDSetWhichSingularTriplets()
|
.seealso: SVDSetWhichSingularTriplets(), SVDWhich
|
@*/
|
@*/
|
PetscErrorCode SVDGetWhichSingularTriplets(SVD svd,SVDWhich *which)
|
PetscErrorCode SVDGetWhichSingularTriplets(SVD svd,SVDWhich *which)
|
{
|
{
|
PetscFunctionBegin;
|
PetscFunctionBegin;
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
PetscValidPointer(which,2);
|
PetscValidPointer(which,2);
|
*which = svd->which;
|
*which = svd->which;
|
PetscFunctionReturn(0);
|
PetscFunctionReturn(0);
|
}
|
}
|
|
|
#undef __FUNCT__
|
#undef __FUNCT__
|
#define __FUNCT__ "SVDSetFromOptions"
|
#define __FUNCT__ "SVDSetFromOptions"
|
/*@
|
/*@
|
SVDSetFromOptions - Sets SVD options from the options database.
|
SVDSetFromOptions - Sets SVD options from the options database.
|
This routine must be called before SVDSetUp() if the user is to be
|
This routine must be called before SVDSetUp() if the user is to be
|
allowed to set the solver type.
|
allowed to set the solver type.
|
|
|
Collective on SVD
|
Collective on SVD
|
|
|
Input Parameters:
|
Input Parameters:
|
. svd - the singular value solver context
|
. svd - the singular value solver context
|
|
|
Notes:
|
Notes:
|
To see all options, run your program with the -help option.
|
To see all options, run your program with the -help option.
|
|
|
Level: beginner
|
Level: beginner
|
|
|
.seealso:
|
.seealso:
|
@*/
|
@*/
|
PetscErrorCode SVDSetFromOptions(SVD svd)
|
PetscErrorCode SVDSetFromOptions(SVD svd)
|
{
|
{
|
PetscErrorCode ierr;
|
PetscErrorCode ierr;
|
char type[256],monfilename[PETSC_MAX_PATH_LEN];
|
char type[256],monfilename[PETSC_MAX_PATH_LEN];
|
PetscTruth flg;
|
PetscTruth flg;
|
const char *mode_list[2] = { "explicit", "implicit" };
|
const char *mode_list[2] = { "explicit", "implicit" };
|
PetscInt i,j;
|
PetscInt i,j;
|
PetscReal r;
|
PetscReal r;
|
PetscViewer monviewer;
|
PetscViewer monviewer;
|
|
|
PetscFunctionBegin;
|
PetscFunctionBegin;
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
svd->setupcalled = 0;
|
svd->setupcalled = 0;
|
ierr = PetscOptionsBegin(svd->comm,svd->prefix,"Singular Value Solver (SVD) Options","SVD");CHKERRQ(ierr);
|
ierr = PetscOptionsBegin(svd->comm,svd->prefix,"Singular Value Solver (SVD) Options","SVD");CHKERRQ(ierr);
|
|
|
ierr = PetscOptionsList("-svd_type","Singular Value Solver method","SVDSetType",SVDList,(char*)(svd->type_name?svd->type_name:SVDCROSS),type,256,&flg);CHKERRQ(ierr);
|
ierr = PetscOptionsList("-svd_type","Singular Value Solver method","SVDSetType",SVDList,(char*)(svd->type_name?svd->type_name:SVDCROSS),type,256,&flg);CHKERRQ(ierr);
|
if (flg) {
|
if (flg) {
|
ierr = SVDSetType(svd,type);CHKERRQ(ierr);
|
ierr = SVDSetType(svd,type);CHKERRQ(ierr);
|
} else if (!svd->type_name) {
|
} else if (!svd->type_name) {
|
ierr = SVDSetType(svd,SVDCROSS);CHKERRQ(ierr);
|
ierr = SVDSetType(svd,SVDCROSS);CHKERRQ(ierr);
|
}
|
}
|
|
|
ierr = PetscOptionsName("-svd_view","Print detailed information on solver used","SVDView",0);CHKERRQ(ierr);
|
ierr = PetscOptionsName("-svd_view","Print detailed information on solver used","SVDView",0);CHKERRQ(ierr);
|
|
|
ierr = PetscOptionsEList("-svd_transpose_mode","Transpose SVD mode","SVDSetTransposeMode",mode_list,2,svd->transmode == PETSC_DECIDE ? "decide" : mode_list[svd->transmode],&i,&flg);CHKERRQ(ierr);
|
ierr = PetscOptionsEList("-svd_transpose_mode","Transpose SVD mode","SVDSetTransposeMode",mode_list,2,svd->transmode == PETSC_DECIDE ? "decide" : mode_list[svd->transmode],&i,&flg);CHKERRQ(ierr);
|
if (flg) {
|
if (flg) {
|
ierr = SVDSetTransposeMode(svd,(SVDTransposeMode)i);CHKERRQ(ierr);
|
ierr = SVDSetTransposeMode(svd,(SVDTransposeMode)i);CHKERRQ(ierr);
|
}
|
}
|
|
|
r = i = PETSC_IGNORE;
|
r = i = PETSC_IGNORE;
|
ierr = PetscOptionsInt("-svd_max_it","Maximum number of iterations","SVDSetTolerances",svd->max_it,&i,PETSC_NULL);CHKERRQ(ierr);
|
ierr = PetscOptionsInt("-svd_max_it","Maximum number of iterations","SVDSetTolerances",svd->max_it,&i,PETSC_NULL);CHKERRQ(ierr);
|
ierr = PetscOptionsReal("-svd_tol","Tolerance","SVDSetTolerances",svd->tol,&r,PETSC_NULL);CHKERRQ(ierr);
|
ierr = PetscOptionsReal("-svd_tol","Tolerance","SVDSetTolerances",svd->tol,&r,PETSC_NULL);CHKERRQ(ierr);
|
ierr = SVDSetTolerances(svd,r,i);CHKERRQ(ierr);
|
ierr = SVDSetTolerances(svd,r,i);CHKERRQ(ierr);
|
|
|
i = j = PETSC_IGNORE;
|
i = j = PETSC_IGNORE;
|
ierr = PetscOptionsInt("-svd_nsv","Number of singular values to compute","SVDSetDimensions",svd->ncv,&i,PETSC_NULL);CHKERRQ(ierr);
|
ierr = PetscOptionsInt("-svd_nsv","Number of singular values to compute","SVDSetDimensions",svd->ncv,&i,PETSC_NULL);CHKERRQ(ierr);
|
ierr = PetscOptionsInt("-svd_ncv","Number of basis vectors","SVDSetDimensions",svd->ncv,&j,PETSC_NULL);CHKERRQ(ierr);
|
ierr = PetscOptionsInt("-svd_ncv","Number of basis vectors","SVDSetDimensions",svd->ncv,&j,PETSC_NULL);CHKERRQ(ierr);
|
ierr = SVDSetDimensions(svd,i,j);CHKERRQ(ierr);
|
ierr = SVDSetDimensions(svd,i,j);CHKERRQ(ierr);
|
|
|
ierr = PetscOptionsTruthGroupBegin("-svd_largest","compute largest singular values","SVDSetWhichSingularTriplets",&flg);CHKERRQ(ierr);
|
ierr = PetscOptionsTruthGroupBegin("-svd_largest","compute largest singular values","SVDSetWhichSingularTriplets",&flg);CHKERRQ(ierr);
|
if (flg) { ierr = SVDSetWhichSingularTriplets(svd,SVD_LARGEST);CHKERRQ(ierr); }
|
if (flg) { ierr = SVDSetWhichSingularTriplets(svd,SVD_LARGEST);CHKERRQ(ierr); }
|
ierr = PetscOptionsTruthGroupEnd("-svd_smallest","compute smallest singular values","SVDSetWhichSingularTriplets",&flg);CHKERRQ(ierr);
|
ierr = PetscOptionsTruthGroupEnd("-svd_smallest","compute smallest singular values","SVDSetWhichSingularTriplets",&flg);CHKERRQ(ierr);
|
if (flg) { ierr = SVDSetWhichSingularTriplets(svd,SVD_SMALLEST);CHKERRQ(ierr); }
|
if (flg) { ierr = SVDSetWhichSingularTriplets(svd,SVD_SMALLEST);CHKERRQ(ierr); }
|
|
|
ierr = PetscOptionsName("-svd_monitor_cancel","Remove any hardwired monitor routines","SVDMonitorCancel",&flg);CHKERRQ(ierr);
|
ierr = PetscOptionsName("-svd_monitor_cancel","Remove any hardwired monitor routines","SVDMonitorCancel",&flg);CHKERRQ(ierr);
|
if (flg) {
|
if (flg) {
|
ierr = SVDMonitorCancel(svd);CHKERRQ(ierr);
|
ierr = SVDMonitorCancel(svd);CHKERRQ(ierr);
|
}
|
}
|
|
|
ierr = PetscOptionsString("-svd_monitor","Monitor approximate singular values and error estimates","SVDMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
|
ierr = PetscOptionsString("-svd_monitor","Monitor approximate singular values and error estimates","SVDMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
|
if (flg) {
|
if (flg) {
|
ierr = PetscViewerASCIIOpen(svd->comm,monfilename,&monviewer);CHKERRQ(ierr);
|
ierr = PetscViewerASCIIOpen(svd->comm,monfilename,&monviewer);CHKERRQ(ierr);
|
ierr = SVDMonitorSet(svd,SVDMonitorDefault,monviewer,(PetscErrorCode (*)(void*))PetscViewerDestroy);CHKERRQ(ierr);
|
ierr = SVDMonitorSet(svd,SVDMonitorDefault,monviewer,(PetscErrorCode (*)(void*))PetscViewerDestroy);CHKERRQ(ierr);
|
}
|
}
|
ierr = PetscOptionsName("-svd_monitor_draw","Monitor error estimates graphically","SVDMonitorSet",&flg);CHKERRQ(ierr);
|
ierr = PetscOptionsName("-svd_monitor_draw","Monitor error estimates graphically","SVDMonitorSet",&flg);CHKERRQ(ierr);
|
if (flg) {
|
if (flg) {
|
ierr = SVDMonitorSet(svd,SVDMonitorLG,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
|
ierr = SVDMonitorSet(svd,SVDMonitorLG,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
|
}
|
}
|
|
|
ierr = PetscOptionsEnd();CHKERRQ(ierr);
|
ierr = PetscOptionsEnd();CHKERRQ(ierr);
|
ierr = IPSetFromOptions(svd->ip);CHKERRQ(ierr);
|
ierr = IPSetFromOptions(svd->ip);CHKERRQ(ierr);
|
if (svd->ops->setfromoptions) {
|
if (svd->ops->setfromoptions) {
|
ierr = (*svd->ops->setfromoptions)(svd);CHKERRQ(ierr);
|
ierr = (*svd->ops->setfromoptions)(svd);CHKERRQ(ierr);
|
}
|
}
|
PetscFunctionReturn(0);
|
PetscFunctionReturn(0);
|
}
|
}
|
|
|
#undef __FUNCT__
|
#undef __FUNCT__
|
#define __FUNCT__ "SVDSetOptionsPrefix"
|
#define __FUNCT__ "SVDSetOptionsPrefix"
|
/*@C
|
/*@C
|
SVDSetOptionsPrefix - Sets the prefix used for searching for all
|
SVDSetOptionsPrefix - Sets the prefix used for searching for all
|
SVD options in the database.
|
SVD options in the database.
|
|
|
Collective on SVD
|
Collective on SVD
|
|
|
Input Parameters:
|
Input Parameters:
|
+ svd - the singular value solver context
|
+ svd - the singular value solver context
|
- prefix - the prefix string to prepend to all SVD option requests
|
- prefix - the prefix string to prepend to all SVD option requests
|
|
|
Notes:
|
Notes:
|
A hyphen (-) must NOT be given at the beginning of the prefix name.
|
A hyphen (-) must NOT be given at the beginning of the prefix name.
|
The first character of all runtime options is AUTOMATICALLY the
|
The first character of all runtime options is AUTOMATICALLY the
|
hyphen.
|
hyphen.
|
|
|
For example, to distinguish between the runtime options for two
|
For example, to distinguish between the runtime options for two
|
different SVD contexts, one could call
|
different SVD contexts, one could call
|
.vb
|
.vb
|
SVDSetOptionsPrefix(svd1,"svd1_")
|
SVDSetOptionsPrefix(svd1,"svd1_")
|
SVDSetOptionsPrefix(svd2,"svd2_")
|
SVDSetOptionsPrefix(svd2,"svd2_")
|
.ve
|
.ve
|
|
|
Level: advanced
|
Level: advanced
|
|
|
.seealso: SVDAppendOptionsPrefix(), SVDGetOptionsPrefix()
|
.seealso: SVDAppendOptionsPrefix(), SVDGetOptionsPrefix()
|
@*/
|
@*/
|
PetscErrorCode SVDSetOptionsPrefix(SVD svd,const char *prefix)
|
PetscErrorCode SVDSetOptionsPrefix(SVD svd,const char *prefix)
|
{
|
{
|
PetscErrorCode ierr;
|
PetscErrorCode ierr;
|
PetscTruth flg1,flg2;
|
PetscTruth flg1,flg2;
|
EPS eps;
|
EPS eps;
|
|
|
PetscFunctionBegin;
|
PetscFunctionBegin;
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
ierr = PetscObjectSetOptionsPrefix((PetscObject)svd,prefix);CHKERRQ(ierr);
|
ierr = PetscObjectSetOptionsPrefix((PetscObject)svd,prefix);CHKERRQ(ierr);
|
ierr = PetscTypeCompare((PetscObject)svd,SVDCROSS,&flg1);CHKERRQ(ierr);
|
ierr = PetscTypeCompare((PetscObject)svd,SVDCROSS,&flg1);CHKERRQ(ierr);
|
ierr = PetscTypeCompare((PetscObject)svd,SVDCYCLIC,&flg2);CHKERRQ(ierr);
|
ierr = PetscTypeCompare((PetscObject)svd,SVDCYCLIC,&flg2);CHKERRQ(ierr);
|
if (flg1) {
|
if (flg1) {
|
ierr = SVDCrossGetEPS(svd,&eps);CHKERRQ(ierr);
|
ierr = SVDCrossGetEPS(svd,&eps);CHKERRQ(ierr);
|
} else if (flg2) {
|
} else if (flg2) {
|
ierr = SVDCyclicGetEPS(svd,&eps);CHKERRQ(ierr);
|
ierr = SVDCyclicGetEPS(svd,&eps);CHKERRQ(ierr);
|
}
|
}
|
if (flg1 || flg2) {
|
if (flg1 || flg2) {
|
ierr = EPSSetOptionsPrefix(eps,prefix);CHKERRQ(ierr);
|
ierr = EPSSetOptionsPrefix(eps,prefix);CHKERRQ(ierr);
|
ierr = EPSAppendOptionsPrefix(eps,"svd_");CHKERRQ(ierr);
|
ierr = EPSAppendOptionsPrefix(eps,"svd_");CHKERRQ(ierr);
|
}
|
}
|
ierr = IPSetOptionsPrefix(svd->ip,prefix);CHKERRQ(ierr);
|
ierr = IPSetOptionsPrefix(svd->ip,prefix);CHKERRQ(ierr);
|
ierr = IPAppendOptionsPrefix(svd->ip,"svd_");CHKERRQ(ierr);
|
ierr = IPAppendOptionsPrefix(svd->ip,"svd_");CHKERRQ(ierr);
|
PetscFunctionReturn(0);
|
PetscFunctionReturn(0);
|
}
|
}
|
|
|
#undef __FUNCT__
|
#undef __FUNCT__
|
#define __FUNCT__ "SVDAppendOptionsPrefix"
|
#define __FUNCT__ "SVDAppendOptionsPrefix"
|
/*@C
|
/*@C
|
SVDAppendOptionsPrefix - Appends to the prefix used for searching for all
|
SVDAppendOptionsPrefix - Appends to the prefix used for searching for all
|
SVD options in the database.
|
SVD options in the database.
|
|
|
Collective on SVD
|
Collective on SVD
|
|
|
Input Parameters:
|
Input Parameters:
|
+ svd - the singular value solver context
|
+ svd - the singular value solver context
|
- prefix - the prefix string to prepend to all SVD option requests
|
- prefix - the prefix string to prepend to all SVD option requests
|
|
|
Notes:
|
Notes:
|
A hyphen (-) must NOT be given at the beginning of the prefix name.
|
A hyphen (-) must NOT be given at the beginning of the prefix name.
|
The first character of all runtime options is AUTOMATICALLY the hyphen.
|
The first character of all runtime options is AUTOMATICALLY the hyphen.
|
|
|
Level: advanced
|
Level: advanced
|
|
|
.seealso: SVDSetOptionsPrefix(), SVDGetOptionsPrefix()
|
.seealso: SVDSetOptionsPrefix(), SVDGetOptionsPrefix()
|
@*/
|
@*/
|
PetscErrorCode SVDAppendOptionsPrefix(SVD svd,const char *prefix)
|
PetscErrorCode SVDAppendOptionsPrefix(SVD svd,const char *prefix)
|
{
|
{
|
PetscErrorCode ierr;
|
PetscErrorCode ierr;
|
PetscTruth flg1,flg2;
|
PetscTruth flg1,flg2;
|
EPS eps;
|
EPS eps;
|
|
|
PetscFunctionBegin;
|
PetscFunctionBegin;
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
ierr = PetscObjectAppendOptionsPrefix((PetscObject)svd,prefix);CHKERRQ(ierr);
|
ierr = PetscObjectAppendOptionsPrefix((PetscObject)svd,prefix);CHKERRQ(ierr);
|
ierr = PetscTypeCompare((PetscObject)svd,SVDCROSS,&flg1);CHKERRQ(ierr);
|
ierr = PetscTypeCompare((PetscObject)svd,SVDCROSS,&flg1);CHKERRQ(ierr);
|
ierr = PetscTypeCompare((PetscObject)svd,SVDCYCLIC,&flg2);CHKERRQ(ierr);
|
ierr = PetscTypeCompare((PetscObject)svd,SVDCYCLIC,&flg2);CHKERRQ(ierr);
|
if (flg1) {
|
if (flg1) {
|
ierr = SVDCrossGetEPS(svd,&eps);CHKERRQ(ierr);
|
ierr = SVDCrossGetEPS(svd,&eps);CHKERRQ(ierr);
|
} else if (flg2) {
|
} else if (flg2) {
|
ierr = SVDCyclicGetEPS(svd,&eps);CHKERRQ(ierr);
|
ierr = SVDCyclicGetEPS(svd,&eps);CHKERRQ(ierr);
|
}
|
}
|
if (flg1 || flg2) {
|
if (flg1 || flg2) {
|
ierr = EPSSetOptionsPrefix(eps,svd->prefix);CHKERRQ(ierr);
|
ierr = EPSSetOptionsPrefix(eps,svd->prefix);CHKERRQ(ierr);
|
ierr = EPSAppendOptionsPrefix(eps,"svd_");CHKERRQ(ierr);
|
ierr = EPSAppendOptionsPrefix(eps,"svd_");CHKERRQ(ierr);
|
}
|
}
|
ierr = IPSetOptionsPrefix(svd->ip,svd->prefix);CHKERRQ(ierr);
|
ierr = IPSetOptionsPrefix(svd->ip,svd->prefix);CHKERRQ(ierr);
|
ierr = IPAppendOptionsPrefix(svd->ip,"svd_");CHKERRQ(ierr);
|
ierr = IPAppendOptionsPrefix(svd->ip,"svd_");CHKERRQ(ierr);
|
PetscFunctionReturn(0);
|
PetscFunctionReturn(0);
|
}
|
}
|
|
|
#undef __FUNCT__
|
#undef __FUNCT__
|
#define __FUNCT__ "SVDGetOptionsPrefix"
|
#define __FUNCT__ "SVDGetOptionsPrefix"
|
/*@C
|
/*@C
|
SVDGetOptionsPrefix - Gets the prefix used for searching for all
|
SVDGetOptionsPrefix - Gets the prefix used for searching for all
|
SVD options in the database.
|
SVD options in the database.
|
|
|
Not Collective
|
Not Collective
|
|
|
Input Parameters:
|
Input Parameters:
|
. svd - the singular value solver context
|
. svd - the singular value solver context
|
|
|
Output Parameters:
|
Output Parameters:
|
. prefix - pointer to the prefix string used is returned
|
. prefix - pointer to the prefix string used is returned
|
|
|
Notes: On the fortran side, the user should pass in a string 'prefix' of
|
Notes: On the fortran side, the user should pass in a string 'prefix' of
|
sufficient length to hold the prefix.
|
sufficient length to hold the prefix.
|
|
|
Level: advanced
|
Level: advanced
|
|
|
.seealso: SVDSetOptionsPrefix(), SVDAppendOptionsPrefix()
|
.seealso: SVDSetOptionsPrefix(), SVDAppendOptionsPrefix()
|
@*/
|
@*/
|
PetscErrorCode SVDGetOptionsPrefix(SVD svd,const char *prefix[])
|
PetscErrorCode SVDGetOptionsPrefix(SVD svd,const char *prefix[])
|
{
|
{
|
PetscErrorCode ierr;
|
PetscErrorCode ierr;
|
PetscFunctionBegin;
|
PetscFunctionBegin;
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
PetscValidHeaderSpecific(svd,SVD_COOKIE,1);
|
PetscValidPointer(prefix,2);
|
PetscValidPointer(prefix,2);
|
ierr = PetscObjectGetOptionsPrefix((PetscObject)svd,prefix);CHKERRQ(ierr);
|
ierr = PetscObjectGetOptionsPrefix((PetscObject)svd,prefix);CHKERRQ(ierr);
|
PetscFunctionReturn(0);
|
PetscFunctionReturn(0);
|
}
|
}
|
|
|
|
|
|
|