slepc4py.SLEPc.RG#
- class slepc4py.SLEPc.RG#
Bases:
ObjectRG.
Enumerations
Methods Summary
appendOptionsPrefix([prefix])Append to the prefix used for searching for all RG options in the database.
canUseConjugates([realmats])Half of integration points can be avoided (use their conjugates).
checkInside(a)Determine if a set of given points are inside the region or not.
Endpoints of a rectangle in the complex plane containing the region.
Compute the coordinates of several points of the contour on the region.
computeQuadrature(quad, n)Compute the values of the parameters used in a quadrature rule.
create([comm])Create the RG object.
destroy()Destroy the RG object.
Get the flag indicating whether the region is complemented or not.
Get the parameters that define the ellipse region.
Get the parameters that define the interval region.
Get the prefix used for searching for all RG options in the database.
Get the parameters that define the interval region.
Get the parameters that define the ring region.
getScale()Get the scaling factor.
getType()Get the RG type of this object.
isAxisymmetric([vertical])Determine if the region is symmetric wrt.
Tell whether it is the trivial region (whole complex plane).
setComplement([comp])Set a flag to indicate that the region is the complement of the specified one.
setEllipseParameters(center, radius[, vscale])Set the parameters defining the ellipse region.
Set RG options from the options database.
setIntervalEndpoints(a, b, c, d)Set the parameters defining the interval region.
setOptionsPrefix([prefix])Set the prefix used for searching for all RG options in the database.
Set the vertices that define the polygon region.
setRingParameters(center, radius, vscale, ...)Set the parameters defining the ring region.
setScale([sfactor])Set the scaling factor to be used.
setType(rg_type)Set the type for the RG object.
view([viewer])Print the RG data structure.
Attributes Summary
If the region is the complement of the specified one.
The scaling factor to be used.
Methods Documentation
- appendOptionsPrefix(prefix=None)#
Append to the prefix used for searching for all RG options in the database.
Logically collective.
- canUseConjugates(realmats=True)#
Half of integration points can be avoided (use their conjugates).
Not collective.
Used in contour integral methods to determine whether half of integration points can be avoided (use their conjugates).
- Parameters:
realmats (bool) – True if the problem matrices are real.
- Returns:
Whether it is possible to use conjugates.
- Return type:
- checkInside(a)#
Determine if a set of given points are inside the region or not.
Not collective.
- Parameters:
- Returns:
Computed result for each point (1=inside, 0=on the contour, -1=outside).
- Return type:
- computeBoundingBox()#
Endpoints of a rectangle in the complex plane containing the region.
Not collective.
Determine the endpoints of a rectangle in the complex plane that contains the region.
- Returns:
- Return type:
- computeContour(n)#
Compute the coordinates of several points of the contour on the region.
Not collective.
Compute the coordinates of several points lying on the contour of the region.
- Parameters:
n (int) – The number of points to compute.
- Returns:
Computed points.
- Return type:
- computeQuadrature(quad, n)#
Compute the values of the parameters used in a quadrature rule.
Not collective.
Compute the values of the parameters used in a quadrature rule for a contour integral around the boundary of the region.
- Parameters:
- Returns:
z (
ArrayScalar) – Quadrature points.zn (
ArrayScalar) – Normalized quadrature points.w (
ArrayScalar) – Quadrature weights.
- Return type:
- create(comm=None)#
Create the RG object.
Collective.
- destroy()#
Destroy the RG object.
Collective.
Source code at slepc4py/SLEPc/RG.pyx:48
- Return type:
- getComplement()#
Get the flag indicating whether the region is complemented or not.
Not collective.
- Returns:
Whether the region is complemented or not.
- Return type:
- getEllipseParameters()#
Get the parameters that define the ellipse region.
Not collective.
- Returns:
- Return type:
- getIntervalEndpoints()#
Get the parameters that define the interval region.
Not collective.
- Returns:
- Return type:
- getOptionsPrefix()#
Get the prefix used for searching for all RG options in the database.
Not collective.
- Returns:
The prefix string set for this RG object.
- Return type:
- getPolygonVertices()#
Get the parameters that define the interval region.
Not collective.
- Returns:
The vertices.
- Return type:
- getRingParameters()#
Get the parameters that define the ring region.
Not collective.
- Returns:
- Return type:
- getScale()#
Get the scaling factor.
Not collective.
- Returns:
The scaling factor.
- Return type:
- getType()#
Get the RG type of this object.
Not collective.
- Returns:
The inner product type currently being used.
- Return type:
- isAxisymmetric(vertical=False)#
Determine if the region is symmetric wrt. the real or imaginary axis.
Not collective.
Determine if the region is symmetric with respect to the real or imaginary axis.
- Parameters:
vertical (bool) – True if symmetry must be checked against the vertical axis.
- Returns:
True if the region is axisymmetric.
- Return type:
- isTrivial()#
Tell whether it is the trivial region (whole complex plane).
Not collective.
- Returns:
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.
- Return type:
- setComplement(comp=True)#
Set a flag to indicate that the region is the complement of the specified one.
Logically collective.
- setEllipseParameters(center, radius, vscale=None)#
Set the parameters defining the ellipse region.
Logically collective.
- Parameters:
- Return type:
- setFromOptions()#
Set RG options from the options database.
Collective.
Notes
To see all options, run your program with the
-helpoption.Source code at slepc4py/SLEPc/RG.pyx:156
- Return type:
- setIntervalEndpoints(a, b, c, d)#
Set the parameters defining the interval region.
Logically collective.
- Parameters:
- Return type:
- setOptionsPrefix(prefix=None)#
Set the prefix used for searching for all RG options in the database.
Logically collective.
- Parameters:
prefix (str | None) – The prefix string to prepend to all RG option requests.
- Return type:
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.
- setPolygonVertices(v)#
Set the vertices that define the polygon region.
Logically collective.
- setRingParameters(center, radius, vscale, start_ang, end_ang, width)#
Set the parameters defining the ring region.
Logically collective.
- Parameters:
- Return type:
- setScale(sfactor=None)#
Set the scaling factor to be used.
Logically collective.
Set the scaling factor to be used when checking that a point is inside the region and when computing the contour.
- setType(rg_type)#
Set the type for the RG object.
Logically collective.
- view(viewer=None)#
Print the RG data structure.
Collective.
Attributes Documentation
- complement#
If the region is the complement of the specified one.
- scale#
The scaling factor to be used.