pyrw.RWgeometry module¶
-
class
pyrw.RWgeometry.
arc
(domain, vstart, vcenter, Id, vend=None, angle=None)¶ Bases:
pyrw.RWgeometry.edge
Arc class for defining domain geometry.
Parameters: - domain (pyrw.RWdomain) – A pyrw domain.
- vstart (pyrw.RWgeometry.vertex) – Start vertex of the arc.
- vcenter (pyrw.RWgeometry.vertex) – Center vertex of the arc.
- Id (int) – ID of arc.
- vend (pyrw.RWgeometry.vertex) – Second vertex of the arc.
- angle (float) – Angle of arc.
-
computeAngle
(debug=False)¶ Computes both angle and angle_offset of arc
Parameters: debug (bool) – Debugging flag. Returns: (float,float) – angle, angle_offset
-
computePoint
(angle, radius)¶ Computes point on arc
Parameters: - angle (float) – Point’s angle.
- radius (float) – Point’s radius.
-
computeRadius
()¶
-
computeVend
()¶
-
computeVstart
()¶
-
draw
(r=None, color=None, ann=False)¶ Draw arc
Parameters: - r (pyrw.RWrun) – pyrw run, if None, picks last run of main pyrw.RWRW object.
- color (matplotlib color) – color of arc in matplotlib syntax, e.g. ‘r’ or (0.1,1,0.5)
- ann (bool) – Annotation Flag
-
genFromAngle
(vcenter, vstart, angle)¶ Initializes arc if angle was given at initialization
Parameters: - vstart (pyrw.RWgeometry.vertex) – Start vertex of the arc.
- vcenter (pyrw.RWgeometry.vertex) – Center vertex of the arc.
- angle (float) – Angle of arc.
-
genFromPoints
(vcenter, vstart, vend)¶ Initializes arc if vend was given at initialization
Parameters: - vstart (pyrw.RWgeometry.vertex) – Start vertex of the arc.
- vcenter (pyrw.RWgeometry.vertex) – Center vertex of the arc.
- vend (pyrw.RWgeometry.vertex) – Second vertex of the arc.
-
getAngle
()¶
-
getAngleOffset
()¶
-
getRadius
()¶
-
getVcenter
()¶
-
getVend
()¶
-
getVstart
()¶
-
getXcenter
()¶
-
getXend
()¶
-
getXstart
()¶
-
inArc
(x, debug=False)¶ Checks if points x lies on arc
Parameters: - x (array) – coordinate.
- debug (bool) – Debugging flag.
-
setAngle
(angle)¶
-
setRadius
(radius)¶
-
class
pyrw.RWgeometry.
circle
(domain, vcenter, radius)¶ Circle class for defining domain geometry.
Parameters: - domain (pyrw.RWdomain) – A pyrw domain.
- vcenter (pyrw.RWgeometry.vertex) – Center vertex of the arc.
- radius (float) – Radius.
-
draw
()¶
-
getArcs
()¶
-
getDomain
()¶
-
getRadius
()¶
-
getVcenter
()¶
-
getVertices
()¶
-
getXcenter
()¶
-
setRadius
(radius)¶
-
setVcenter
(v)¶
-
setXcenter
(x)¶
-
class
pyrw.RWgeometry.
edge
(domain, Id, typ)¶ Edge class for defining domain geometry.
Parameters: - domain (pyrw.RWdomain) – A pyrw domain.
- Id (int) – ID of edge.
- typ (int) – Edge type
-
decodeTyp
()¶ Returns type of edge in words.
Returns: str – type of the edge
-
getDomain
()¶
-
getId
()¶
-
getTyp
()¶
-
class
pyrw.RWgeometry.
line
(domain, v1, v2, Id)¶ Bases:
pyrw.RWgeometry.edge
Line class for defining domain geometry.
Parameters: - domain (pyrw.RWdomain) – A pyrw domain.
- Id (int) – ID of line.
- v1 (pyrw.RWgeometry.vertex) – Start vertex of the line.
- v2 (pyrw.RWgeometry.vertex) – Second vertex of the line.
-
draw
(r=None, color=None, ann=False)¶ Draw line
Parameters: - r (pyrw.RWrun) – pyrw run, if None, picks last run of main pyrw.RWRW object.
- color (matplotlib color) – color of line in matplotlib syntax, e.g. ‘r’ or (0.1,1,0.5)
- ann (bool) – Annotation Flag
-
class
pyrw.RWgeometry.
rectangle
(domain, voffset, lenx, leny)¶ Rectangle class for defining domain geometry.
Parameters: - domain (pyrw.RWdomain) – A pyrw domain.
- voffset (pyrw.RWgeometry.vertex) – Offset vertex of the arc.
- lenx (float) – Sidelength in x direction.
- leny (float) – Sidelength in y direction.
-
draw
(r=None, color=None, ann=None)¶
-
getDomain
()¶
-
getEdges
()¶
-
getLenx
()¶
-
getLeny
()¶
-
getVertices
()¶
-
getVoffset
()¶
-
getXoffset
()¶
-
setLenx
(lenx)¶
-
setLeny
(leny)¶
-
setXoffset
(xoffset)¶
-
class
pyrw.RWgeometry.
vertex
(domain, x, Id)¶ Vertex class for defining domain geometry.
Parameters: - domain (pyrw.RWdomain) – A pyrw domain.
- x (array) – A coordinate, e.g. [0,1].
- Id (int) – ID of vertex.
-
draw
(r=None, color=None, ann=False)¶ Draw vertex
Parameters: - r (pyrw.RWrun object) – pyrw run, if None, picks last run of main pyrw.RWRW object.
- color (matplotlib color) – color of vertex in matplotlib syntax, e.g. ‘r’ or (0.1,1,0.5)
- ann (bool) – Annotation Flag
-
setX
(x)¶ Define vertex location
Parameters: x (array) – A coordinate, e.g. [0,1]