Describe a cylinder for mesh tag assignment. More...
Inheritance diagram for carputils.mesh.region.CylinderRegion:
Public Member Functions | |
| def | __init__ (self, radius=0., start=(0., 0., 0.), axis=(0., 0., 0.), tag=None, bath=0) |
| def | __call__ (self, coord) |
| def | mesher_opts (self, i) |
| def | carp_opts (self, i) |
 Public Member Functions inherited from carputils.mesh.region.Region | |
| def | __init__ (self, tag=None, bath=0, rtype=0, p0=(0., 0., 0.), p1=(0., 0., 0.), radius=0., ctype=None) |
| def | mesher_opts (self, i) |
| Generate the mesher option list for this region. More... | |
| def | carp_opts (self, i) |
| Generate the carp option list for this tag region. More... | |
| def | __call__ (self, coord) |
| Reimplement with logic determining if coord (mm) is in the region. More... | |
Public Attributes | |
| axis_mag | |
| normalised_axis | |
| Public Attributes inherited from carputils.mesh.region.Region | |
| tag | |
| bath | |
| rtype | |
| radius | |
| p0 | |
| p1 | |
| ctype | |
Detailed Description
Describe a cylinder for mesh tag assignment.
- Parameters
-
start array-like Starting point axis array-like axis of cylinder with magnitude being the length of the cylinder radius float, optional Radius of the sphere, defaults to 0 centre array-like, optional Centre of the sphere, defaults to (0,0,0) tag int, optional Tag ID to assign to this region, defaults to auto assign by mesher bath int, optional 0 no bath, 1 - isotropic bath, 2 - anisotropic bath, default is 0
Constructor & Destructor Documentation
◆ __init__()
| def carputils.mesh.region.CylinderRegion.__init__ | ( | self, | |
radius = 0., |
|||
start = (0., 0., 0.), |
|||
axis = (0., 0., 0.), |
|||
tag = None, |
|||
bath = 0 |
|||
| ) |
Member Function Documentation
◆ __call__()
| def carputils.mesh.region.CylinderRegion.__call__ | ( | self, | |
| coord | |||
| ) |
◆ carp_opts()
| def carputils.mesh.region.CylinderRegion.carp_opts | ( | self, | |
| i | |||
| ) |
◆ mesher_opts()
| def carputils.mesh.region.CylinderRegion.mesher_opts | ( | self, | |
| i | |||
| ) |
Member Data Documentation
◆ axis_mag
| carputils.mesh.region.CylinderRegion.axis_mag |
◆ normalised_axis
| carputils.mesh.region.CylinderRegion.normalised_axis |
The documentation for this class was generated from the following file:
- carputils/mesh/region.py
