Home | Trees | Indices | Help |
|
---|
|
DS
|
|||
MatType To refer to one of the matrices stored internally in DS |
|||
StateType DS state types |
|||
Type DS type |
|
|||
a new object with type S, a subtype of T |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from Inherited from |
|
|||
Inherited from Inherited from |
|
|
Allocates memory for internal storage or matrices in DS. Parameters ---------- ld: integer Leading dimension (maximum allowed dimension for the matrices, including the extra row if present). |
Creates the DS object. Parameters ---------- comm: Comm, optional MPI communicator; if not provided, it defaults to all processes. |
Destroys the DS object.
|
Gets the compact storage flag. Returns ------- comp: boolean The flag. |
Returns the current dimensions. Returns ------- n: int The new size. m: int The new column size (only for SVD). l: int Number of locked (inactive) leading columns. k: int Intermediate dimension (e.g., position of arrow). t: int Truncated length. |
Gets the extra row flag. Returns ------- comp: boolean The flag. |
Returns the leading dimension of the allocated matrices. Returns ------- ld: integer Leading dimension (maximum allowed dimension for the matrices). |
Returns the requested matrix as a sequential dense Mat object. Parameters ---------- matname: `DS.MatType` enumerate The requested matrix. |
Gets the method currently used in the DS. Returns ------- meth: int Identifier of the method. |
Gets the prefix used for searching for all DS options in the database. Returns ------- prefix: string The prefix string set for this DS object.
|
Gets the refined vectors flag. Returns ------- comp: boolean The flag. |
Returns the current state. Returns ------- state: `DS.StateType` enumerate The current state. |
Gets the DS type of this object. Returns ------- type: `DS.Type` enumerate The direct solver type currently being used.
|
Switch to compact storage of matrices. Parameters ---------- comp: boolean A boolean flag. Notes ----- Compact storage is used in some `DS` types such as `DS.Type.HEP` when the matrix is tridiagonal. This flag can be used to indicate whether the user provides the matrix entries via the compact form (the tridiagonal `DS.MatType.T`) or the non-compact one (`DS.MatType.A`). The default is ``False``. |
Resize the matrices in the DS object. Parameters ---------- n: int, optional The new size. m: int, optional The new column size (only for SVD). l: int, optional Number of locked (inactive) leading columns. k: int, optional Intermediate dimension (e.g., position of arrow). Notes ----- The internal arrays are not reallocated. The value `m` is not used except in the case of DS.SVD. |
Sets a flag to indicate that the matrix has one extra row. Parameters ---------- ext: boolean A boolean flag. Notes ----- In Krylov methods it is useful that the matrix representing the direct solver has one extra row, i.e., has dimension (n+1)*n . If this flag is activated, all transformations applied to the right of the matrix also affect this additional row. In that case, (n+1) must be less or equal than the leading dimension. The default is ``False``. |
Sets DS options from the options database. Notes ----- To see all options, run your program with the ``-help`` option.
|
Selects the method to be used to solve the problem. Parameters ---------- meth: int An index indentifying the method. |
Sets the prefix used for searching for all DS options in the database. Parameters ---------- prefix: string The prefix string to prepend to all DS option requests. Notes ----- A hyphen (``-``) must NOT be given at the beginning of the prefix name. The first character of all runtime options is AUTOMATICALLY the hyphen.
|
Sets a flag to indicate that refined vectors must be computed. Parameters ---------- ref: boolean A boolean flag. Notes ----- Normally the vectors returned in `DS.MatType.X` are eigenvectors of the projected matrix. With this flag activated, `vectors()` will return the right singular vector of the smallest singular value of matrix At-theta*I, where At is the extended (n+1)xn matrix and theta is the Ritz value. This is used in the refined Ritz approximation. The default is ``False``. |
Change the state of the DS object. Parameters ---------- state: `DS.StateType` enumerate The new state. Notes ----- The state indicates that the dense system is in an initial state (raw), in an intermediate state (such as tridiagonal, Hessenberg or Hessenberg-triangular), in a condensed state (such as diagonal, Schur or generalized Schur), or in a truncated state. This function is normally used to return to the raw state when the condensed structure is destroyed. |
Selects the type for the DS object. Parameters ---------- ds_type: `DS.Type` enumerate The direct solver type to be used. |
Truncates the system represented in the DS object. Parameters ---------- n: integer The new size. |
Prints the DS 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 |