Home | Trees | Indices | Help |
|
---|
|
RG
|
|||
QuadRule RG quadrature rule for contour integral methods |
|||
Type RG type |
|
|||
a new object with type S, a subtype of T |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from Inherited from |
|
|||
complement | |||
scale | |||
Inherited from Inherited from |
|
|
Used in contour integral methods to determine whether half of integration points can be avoided (use their conjugates). Parameters ---------- realmats: bool, optional True if the problem matrices are real. Returns ------- useconj: bool Whether it is possible to use conjugates. |
Determines if a set of given points are inside the region or not. Parameters ---------- a: list of float (complex) The coordinates of the points. Returns ------- inside: list of int Computed result for each point (1=inside, 0=on the contour, -1=outside). |
Determines the endpoints of a rectangle in the complex plane that contains the region. Returns ------- a: float The left endpoint of the bounding box in the real axis b: float The right endpoint of the bounding box in the real axis c: float The left endpoint of the bounding box in the imaginary axis d: float The right endpoint of the bounding box in the imaginary axis |
Computes the coordinates of several points lying on the contour of the region. Parameters ---------- n: int The number of points to compute. Returns ------- x: list of float (complex) Computed points. |
Computes the values of the parameters used in a quadrature rule for a contour integral around the boundary of the region. Parameters ---------- quad: `RG.QuadRule` enumerate The type of quadrature. n: int The number of quadrature points to compute. Returns ------- z: list of float (real or complex) Quadrature points. zn: list of float (real or complex) Normalized quadrature points. w: list of float (real or complex) Quadrature weights. |
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 parameters that define the interval region. Returns ------- v: list of float (complex) The vertices. |
Gets the parameters that define the ring region. Returns ------- center: float (real or complex) The center. radius: float The radius. vscale: float The vertical scale. start_ang: float The right-hand side angle. end_ang: float The left-hand side angle. width: float The width of the ring. |
Gets the scaling factor. Returns ------- sfactor: float The scaling factor. |
Gets the RG type of this object. Returns ------- type: `RG.Type` enumerate The inner product type currently being used.
|
Determines if the region is symmetric with respect to the real or imaginary axis. Parameters ---------- vertical: bool, optional True if symmetry must be checked against the vertical axis. Returns ------- symm: bool True if the region is axisymmetric. |
Tells whether it is the trivial region (whole complex plane). Returns ------- flag: bool 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, optional 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, optional 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.
|
Sets the vertices that define the polygon region. Parameters ---------- v: list of float (complex) The vertices. |
Sets the parameters defining the ring region. Parameters ---------- center: float (real or complex) The center. radius: float The radius. vscale: float The vertical scale. start_ang: float The right-hand side angle. end_ang: float The left-hand side angle. width: float The width of the ring. |
Sets the scaling factor to be used when checking that a point is inside the region and when computing the contour. Parameters ---------- sfactor: float, optional The scaling factor (default=1). |
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 Mon Oct 4 12:32:49 2021 | http://epydoc.sourceforge.net |