a new object with type S, a subtype of T
|
|
|
appendOptionsPrefix(self,
prefix)
Appends to the prefix used for searching for all PEP options
in the database. |
|
|
|
cancelMonitor(self)
Clears all monitors for a PEP object. |
|
|
|
computeError(self,
int i,
etype=None)
Computes the error (based on the residual norm) associated with the i-th
computed eigenpair. |
|
|
|
create(self,
comm=None)
Creates the PEP object. |
|
|
|
destroy(self)
Destroys the PEP object. |
|
|
|
errorView(self,
etype=None,
Viewer viewer=None)
Displays the errors associated with the computed solution
(as well as the eigenvalues). |
|
|
|
getBV(self)
Obtain the basis vectors object associated to the eigensolver. |
|
|
|
getBasis(self)
Gets the type of polynomial basis used to
describe the polynomial eigenvalue problem. |
|
|
|
|
|
|
|
getConvergenceTest(self)
Return the method used to compute the error estimate
used in the convergence test. |
|
|
|
getDimensions(self)
Gets the number of eigenvalues to compute and the dimension of
the subspace. |
|
|
|
getEigenpair(self,
int i,
Vec Vr=None,
Vec Vi=None)
Gets the i-th solution of the eigenproblem as computed by
solve(). |
|
|
|
getErrorEstimate(self,
int i)
Returns the error estimate associated to the i-th computed
eigenpair. |
|
|
|
getInterval(self)
Gets the computational interval for spectrum slicing. |
|
|
|
|
|
getJDFix(self)
Gets threshold for changing the target in the correction equation. |
|
|
|
getJDRestart(self)
Gets the restart parameter used in the Jacobi-Davidson method. |
|
|
|
getLinearCompanionForm(self)
Returns the number of the companion form that will be used for the
linearization of a quadratic eigenproblem. |
|
|
|
getLinearEPS(self)
Retrieve the eigensolver object (EPS) associated to the polynomial
eigenvalue solver. |
|
|
|
getLinearExplicitMatrix(self)
Returns the flag indicating if the matrices A and B for the linearization
are built explicitly. |
|
|
|
getOperators(self)
Gets the matrices associated with the eigenvalue problem. |
|
|
|
getOptionsPrefix(self)
Gets the prefix used for searching for all PEP options in the
database. |
|
|
|
|
|
getRG(self)
Obtain the region object associated to the eigensolver. |
|
|
|
getRefine(self)
Gets the refinement strategy used by the PEP object,
and the associated parameters. |
|
|
|
getST(self)
Obtain the spectral transformation (ST) object associated to
the eigensolver object. |
|
|
|
|
|
getSTOARDimensions(self)
Gets the dimensions used for each subsolve step in case of doing
spectrum slicing for a computational interval. |
|
|
|
|
|
getScale(self,
Vec Dl=None,
Vec Dr=None)
Gets the strategy used for scaling the polynomial eigenproblem. |
|
|
|
|
|
getTOARRestart(self)
Gets the restart parameter used in the TOAR method. |
|
|
|
getTarget(self)
Gets the value of the target. |
|
|
|
getTolerances(self)
Gets the tolerance and maximum iteration count used by the
default PEP convergence tests. |
|
|
|
getTrackAll(self)
Returns the flag indicating whether all residual norms must be
computed or not. |
|
|
|
getType(self)
Gets the PEP type of this object. |
|
|
|
|
|
reset(self)
Resets the PEP object. |
|
|
|
setBV(self,
BV bv)
Associates a basis vectors object to the eigensolver. |
|
|
|
setBasis(self,
basis)
Specifies the type of polynomial basis used to
describe the polynomial eigenvalue problem. |
|
|
|
setConvergenceTest(self,
conv)
Specifies how to compute the error estimate
used in the convergence test. |
|
|
|
setDimensions(self,
nev=None,
ncv=None,
mpd=None)
Sets the number of eigenvalues to compute and the dimension of
the subspace. |
|
|
|
|
|
setInitialSpace(self,
space)
Sets the initial space from which the eigensolver starts to
iterate. |
|
|
|
setInterval(self,
inta,
intb)
Defines the computational interval for spectrum slicing. |
|
|
|
setJDFix(self,
fix)
Sets the threshold for changing the target in the correction
equation. |
|
|
|
setJDRestart(self,
keep)
Sets the restart parameter for the Jacobi-Davidson method, in
particular the proportion of basis vectors that must be kept
after restart. |
|
|
|
setLinearCompanionForm(self,
int cform)
Choose between the two companion forms available for the linearization of
a quadratic eigenproblem. |
|
|
|
setLinearEPS(self,
EPS eps)
Associate an eigensolver object (EPS) to the polynomial eigenvalue solver. |
|
|
|
setLinearExplicitMatrix(self,
flag)
Indicate if the matrices A and B for the linearization of the problem
must be built explicitly. |
|
|
|
setOperators(self,
operators)
Sets the matrices associated with the eigenvalue problem. |
|
|
|
setOptionsPrefix(self,
prefix)
Sets the prefix used for searching for all PEP options in the
database. |
|
|
|
setProblemType(self,
problem_type)
Specifies the type of the eigenvalue problem. |
|
|
|
setRG(self,
RG rg)
Associates a region object to the eigensolver. |
|
|
|
setRefine(self,
ref,
npart=None,
tol=None,
its=None,
scheme=None)
Sets the refinement strategy used by the PEP object,
and the associated parameters. |
|
|
|
setST(self,
ST st)
Associates a spectral transformation object to the
eigensolver. |
|
|
|
setSTOARDetectZeros(self,
detect)
Sets a flag to enforce detection of zeros during the factorizations
throughout the spectrum slicing computation. |
|
|
|
setSTOARDimensions(self,
nev=None,
ncv=None,
mpd=None)
Sets the dimensions used for each subsolve step in case of doing
spectrum slicing for a computational interval. |
|
|
|
setSTOARLocking(self,
lock)
Choose between locking and non-locking variants of the
STOAR method. |
|
|
|
setScale(self,
scale,
alpha=None,
Vec Dl=None,
Vec Dr=None,
its=None,
lbda=None)
Sets the scaling strategy to be used for scaling the polynomial problem
before attempting to solve. |
|
|
|
setTOARLocking(self,
lock)
Choose between locking and non-locking variants of the
TOAR method. |
|
|
|
setTOARRestart(self,
keep)
Sets the restart parameter for the TOAR method, in
particular the proportion of basis vectors that must be kept
after restart. |
|
|
|
setTarget(self,
target)
Sets the value of the target. |
|
|
|
setTolerances(self,
tol=None,
max_it=None)
Sets the tolerance and maximum iteration count used by the
default PEP convergence tests. |
|
|
|
setTrackAll(self,
trackall)
Specifies if the solver must compute the residual of all
approximate eigenpairs or not. |
|
|
|
setType(self,
pep_type)
Selects the particular solver to be used in the PEP object. |
|
|
|
setUp(self)
Sets up all the internal data structures necessary for the
execution of the eigensolver. |
|
|
|
|
|
solve(self)
Solves the eigensystem. |
|
|
|
view(self,
Viewer viewer=None)
Prints the PEP data structure. |
|
|
Inherited from petsc4py.PETSc.Object :
__copy__ ,
__deepcopy__ ,
__eq__ ,
__ge__ ,
__gt__ ,
__le__ ,
__lt__ ,
__ne__ ,
__nonzero__ ,
compose ,
decRef ,
getAttr ,
getClassId ,
getClassName ,
getComm ,
getDict ,
getName ,
getRefCount ,
getTabLevel ,
incRef ,
incrementTabLevel ,
query ,
setAttr ,
setName ,
setTabLevel ,
stateIncrease ,
viewFromOptions
|