Home | Trees | Indices | Help |
|
---|
|
MFN
|
|||
ConvergedReason | |||
Type MFN type |
|
|||
a new object with type S, a subtype of T |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from Inherited from |
|
|||
Inherited from Inherited from |
|
|
Appends to the prefix used for searching for all MFN options in the database. Parameters ---------- prefix: string The prefix string to prepend to all MFN option requests. |
Creates the MFN object. Parameters ---------- comm: Comm, optional. MPI communicator. If not provided, it defaults to all processes. |
Destroys the MFN object.
|
Obtain the basis vector object associated to the MFN object. Returns ------- bv: BV The basis vectors context. |
Gets the reason why the `solve()` iteration was stopped. Returns ------- reason: `MFN.ConvergedReason` enumerate Negative value indicates diverged, positive value converged. |
Gets the dimension of the subspace used by the solver. Returns ------- ncv: int Maximum dimension of the subspace to be used by the solver. |
Obtain the math function object associated to the MFN object. Returns ------- fn: FN The math function context. |
Gets the current iteration number. If the call to `solve()` is complete, then it returns the number of iterations carried out by the solution method. Returns ------- its: int Iteration number. |
Gets the matrix associated with the MFN object. Returns ------- A: Mat The matrix for which the matrix function is to be computed. |
Gets the prefix used for searching for all MFN options in the database. Returns ------- prefix: string The prefix string set for this MFN object.
|
Gets the tolerance and maximum iteration count used by the default MFN convergence tests. Returns ------- tol: float The convergence tolerance. max_it: int The maximum number of iterations |
Gets the MFN type of this object. Returns ------- type: `MFN.Type` enumerate The solver currently being used.
|
Associates a basis vector object to the MFN object. Parameters ---------- bv: BV The basis vectors context. |
Sets the dimension of the subspace to be used by the solver. Parameters ---------- ncv: int Maximum dimension of the subspace to be used by the solver. |
Associates a math function object to the MFN object. Parameters ---------- fn: FN The math function context. |
Sets MFN options from the options database. This routine must be called before `setUp()` if the user is to be allowed to set the solver type.
|
Sets the matrix associated with the MFN object. Parameters ---------- A: Mat The problem matrix. |
Sets the prefix used for searching for all MFN options in the database. Parameters ---------- prefix: string The prefix string to prepend to all MFN option requests.
|
Sets the tolerance and maximum iteration count used by the default MFN convergence tests. Parameters ---------- tol: float, optional The convergence tolerance. max_it: int, optional The maximum number of iterations |
Selects the particular solver to be used in the MFN object. Parameters ---------- mfn_type: `MFN.Type` enumerate The solver to be used. |
Solves the matrix function problem. Given a vector b, the vector x = f(alpha*A)*b is returned. Parameters ---------- b: Vec The right hand side vector. x: Vec The solution. |
Prints the MFN data structure. Parameters ---------- viewer: Viewer, optional. Visualization context; if not provided, the standard output is used.
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Wed Oct 14 09:49:44 2020 | http://epydoc.sourceforge.net |