Home | Trees | Indices | Help |
|
---|
|
RG
|
|||
Type RG type |
|
|||
a new object with type S, a subtype of T |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from Inherited from |
|
|||
Inherited from Inherited from |
|
|
Creates the RG object. Parameters ---------- comm: Comm, optional MPI communicator; if not provided, it defaults to all processes. |
Destroys the RG object.
|
Returns the flag indicating whether the region is complemented or not. Returns ------- flg: bool Whether the region is complemented or not. |
Gets the parameters that define the ellipse region. Returns ------- center: float (real or complex) The center. radius: float The radius. vscale: float The vertical scale. |
Gets the parameters that define the interval region. Returns ------- a: float The left endpoint in the real axis. b: float The right endpoint in the real axis. c: float The upper endpoint in the imaginary axis. d: float The lower endpoint in the imaginary axis. |
Gets the prefix used for searching for all RG options in the database. Returns ------- prefix: string The prefix string set for this RG object.
|
Gets the RG type of this object. Returns ------- type: `RG.Type` enumerate The inner product type currently being used.
|
Tells whether it is the trivial region (whole complex plane). Returns ------- flag: boolean True if the region is equal to the whole complex plane, e.g., an interval region with all four endpoints unbounded or an ellipse with infinite radius. |
Sets a flag to indicate that the region is the complement of the specified one. Parameters ---------- comp: bool Activate/deactivate the complementation of the region. |
Sets the parameters defining the ellipse region. Parameters ---------- center: float (real or complex) The center. radius: float The radius. vscale: float The vertical scale. |
Sets RG options from the options database. Notes ----- To see all options, run your program with the ``-help`` option.
|
Sets the parameters defining the interval region. Parameters ---------- a: float The left endpoint in the real axis. b: float The right endpoint in the real axis. c: float The upper endpoint in the imaginary axis. d: float The lower endpoint in the imaginary axis. |
Sets the prefix used for searching for all RG options in the database. Parameters ---------- prefix: string The prefix string to prepend to all RG 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.
|
Selects the type for the RG object. Parameters ---------- rg_type: `RG.Type` enumerate The inner product type to be used. |
Prints the RG 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:45 2020 | http://epydoc.sourceforge.net |