a new object with type S, a subtype of T
|
|
|
appendOptionsPrefix(self,
prefix)
Appends to the prefix used for searching for all NEP options
in the database. |
|
|
|
applyResolvent(self,
omega,
Vec v,
Vec r,
RG rg=None)
Applies the resolvent T^{-1}(z) to a given vector. |
|
|
|
cancelMonitor(self)
Clears all monitors for a NEP 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 NEP object. |
|
|
|
destroy(self)
Destroys the NEP 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. |
|
|
|
|
|
getCISSKSPs(self)
Retrieve the array of linear solver objects associated with
the CISS solver. |
|
|
|
getCISSRefinement(self)
Gets the values of various refinement parameters in the CISS solver. |
|
|
|
getCISSSizes(self)
Gets the values of various size parameters in the CISS solver. |
|
|
|
getCISSThreshold(self)
Gets the values of various threshold parameters in the CISS solver. |
|
|
|
|
|
|
|
getConvergenceTest(self)
Return the method used to compute the error estimate
used in the convergence test. |
|
|
|
getDS(self)
Obtain the direct solver associated to the eigensolver. |
|
|
|
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. |
|
|
|
getFunction(self)
Returns the function to compute the nonlinear Function T(lambda) and the matrix. |
|
|
|
|
|
getInterpolPEP(self)
Retrieve the polynomial eigensolver object associated with the nonlinear eigensolver. |
|
|
|
|
|
getJacobian(self)
Returns the function to compute the Jacobian T'(lambda) and the matrix. |
|
|
|
|
|
getMonitor(self)
Gets the list of monitor functions. |
|
|
|
getNArnoldiKSP(self)
Retrieve the linear solver object associated with the nonlinear eigensolver. |
|
|
|
|
|
getNLEIGSEPS(self)
Retrieve the linear eigensolver object associated with the nonlinear eigensolver. |
|
|
|
getNLEIGSFullBasis(self)
Gets the flag that indicates if NLEIGS is using the full-basis variant. |
|
|
|
getNLEIGSInterpolation(self)
Gets the tolerance and maximum degree when building the
interpolation via divided differences. |
|
|
|
getNLEIGSKSPs(self)
Retrieve the array of linear solver objects associated with
the NLEIGS solver. |
|
|
|
|
|
|
|
|
|
getOptionsPrefix(self)
Gets the prefix used for searching for all NEP options in the
database. |
|
|
|
|
|
getRG(self)
Obtain the region object associated to the eigensolver. |
|
|
|
|
|
|
|
getRIIHermitian(self)
Returns the flag about using the Hermitian version of the scalar
nonlinear equation. |
|
|
|
getRIIKSP(self)
Retrieve the linear solver object associated with the nonlinear eigensolver. |
|
|
|
|
|
|
|
getRefine(self)
Gets the refinement strategy used by the NEP object,
and the associated parameters. |
|
|
|
getRefineKSP(self)
Obtain the KSP object used by the eigensolver in the
refinement phase. |
|
|
|
|
|
getSLPEPS(self)
Retrieve the linear eigensolver object associated with the nonlinear eigensolver. |
|
|
|
|
|
getSLPKSP(self)
Retrieve the linear solver object associated with the nonlinear eigensolver. |
|
|
|
getSplitOperator(self)
Returns the operator of the nonlinear eigenvalue problem
in split form. |
|
|
|
getStoppingTest(self)
Gets the stopping function. |
|
|
|
getTarget(self)
Gets the value of the target. |
|
|
|
getTolerances(self)
Gets the tolerance and maximum iteration count used by the
default NEP convergence tests. |
|
|
|
getTrackAll(self)
Returns the flag indicating whether all residual norms must be
computed or not. |
|
|
|
getTwoSided(self)
Returns the flag indicating whether a two-sided variant
of the algorithm is being used or not. |
|
|
|
getType(self)
Gets the NEP type of this object. |
|
|
|
|
|
reset(self)
Resets the NEP object. |
|
|
|
setBV(self,
BV bv)
Associates a basis vectors object to the eigensolver. |
|
|
|
setCISSExtraction(self,
extraction)
Sets the extraction technique used in the CISS solver. |
|
|
|
setCISSRefinement(self,
inner=None,
blsize=None)
Sets the values of various refinement parameters in the CISS solver. |
|
|
|
setCISSSizes(self,
ip=None,
bs=None,
ms=None,
npart=None,
bsmax=None,
realmats=False)
Sets the values of various size parameters in the CISS solver. |
|
|
|
setCISSThreshold(self,
delta=None,
spur=None)
Sets the values of various threshold parameters in the CISS solver. |
|
|
|
setConvergenceTest(self,
conv)
Specifies how to compute the error estimate
used in the convergence test. |
|
|
|
setDS(self,
DS ds)
Associates a direct solver object to the eigensolver. |
|
|
|
setDimensions(self,
nev=None,
ncv=None,
mpd=None)
Sets the number of eigenvalues to compute and the dimension of
the subspace. |
|
|
|
|
|
setFunction(self,
function,
Mat F=None,
Mat P=None,
args=None,
kargs=None)
Sets the function to compute the nonlinear Function T(lambda)
as well as the location to store the matrix. |
|
|
|
setInitialSpace(self,
space)
Sets the initial space from which the eigensolver starts to
iterate. |
|
|
|
setInterpolInterpolation(self,
tol=None,
deg=None)
Sets the tolerance and maximum degree when building the
interpolation polynomial. |
|
|
|
setInterpolPEP(self,
PEP pep)
Associate a polynomial eigensolver object to the nonlinear eigensolver. |
|
|
|
setJacobian(self,
jacobian,
Mat J=None,
args=None,
kargs=None)
Sets the function to compute the Jacobian T'(lambda) as well
as the location to store the matrix. |
|
|
|
setMonitor(self,
monitor,
args=None,
kargs=None)
Appends a monitor function to the list of monitors. |
|
|
|
setNArnoldiKSP(self,
KSP ksp)
Associate a linear solver object to the nonlinear eigensolver. |
|
|
|
|
|
setNLEIGSEPS(self,
EPS eps)
Associate a linear eigensolver object to the nonlinear eigensolver. |
|
|
|
setNLEIGSFullBasis(self,
fullbasis=True)
Choose between TOAR-basis (default) and full-basis variants
of the NLEIGS method. |
|
|
|
setNLEIGSInterpolation(self,
tol=None,
deg=None)
Sets the tolerance and maximum degree when building the
interpolation via divided differences. |
|
|
|
setNLEIGSLocking(self,
lock)
Choose between locking and non-locking variants of the
NLEIGS method. |
|
|
|
setNLEIGSRKShifts(self,
shifts)
Sets a list of shifts to be used in the Rational Krylov method. |
|
|
|
setNLEIGSRestart(self,
keep)
Sets the restart parameter for the NLEIGS method, in
particular the proportion of basis vectors that must be kept
after restart. |
|
|
|
setOptionsPrefix(self,
prefix)
Sets the prefix used for searching for all NEP 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. |
|
|
|
|
|
setRIIDeflationThreshold(self,
deftol)
Sets the threshold value used to switch between deflated and
non-deflated iteration. |
|
|
|
setRIIHermitian(self,
herm)
Sets a flag to indicate if the Hermitian version of the scalar
nonlinear equation must be used by the solver. |
|
|
|
setRIIKSP(self,
KSP ksp)
Associate a linear solver object to the nonlinear eigensolver. |
|
|
|
|
|
|
|
setRefine(self,
ref,
npart=None,
tol=None,
its=None,
scheme=None)
Sets the refinement strategy used by the NEP object,
and the associated parameters. |
|
|
|
setSLPDeflationThreshold(self,
deftol)
Sets the threshold value used to switch between deflated and
non-deflated iteration. |
|
|
|
setSLPEPS(self,
EPS eps)
Associate a linear eigensolver object to the nonlinear eigensolver. |
|
|
|
setSLPEPSLeft(self,
EPS eps)
Associate a linear eigensolver object to the nonlinear eigensolver,
used to compute left eigenvectors in the two-sided variant of SLP. |
|
|
|
setSLPKSP(self,
KSP ksp)
Associate a linear solver object to the nonlinear eigensolver. |
|
|
|
setSplitOperator(self,
A,
f,
structure=None)
Sets the operator of the nonlinear eigenvalue problem
in split form. |
|
|
|
setStoppingTest(self,
stopping,
args=None,
kargs=None)
Sets a function to decide when to stop the outer iteration of the eigensolver. |
|
|
|
setTarget(self,
target)
Sets the value of the target. |
|
|
|
setTolerances(self,
tol=None,
maxit=None)
Sets the tolerance and maximum iteration count used in convergence tests. |
|
|
|
setTrackAll(self,
trackall)
Specifies if the solver must compute the residual of all
approximate eigenpairs or not. |
|
|
|
setTwoSided(self,
twosided)
Sets the solver to use a two-sided variant so that left
eigenvectors are also computed. |
|
|
|
setType(self,
nep_type)
Selects the particular solver to be used in the NEP object. |
|
|
|
setUp(self)
Sets up all the internal data structures necessary for the
execution of the eigensolver. |
|
|
|
|
|
solve(self)
Solves the eigensystem. |
|
|
|
valuesView(self,
Viewer viewer=None)
Displays the computed eigenvalues in a viewer. |
|
|
|
vectorsView(self,
Viewer viewer=None)
Outputs computed eigenvectors to a viewer. |
|
|
|
view(self,
Viewer viewer=None)
Prints the NEP 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
Inherited from object :
__delattr__ ,
__format__ ,
__getattribute__ ,
__hash__ ,
__init__ ,
__reduce__ ,
__reduce_ex__ ,
__repr__ ,
__setattr__ ,
__sizeof__ ,
__str__ ,
__subclasshook__
|