carputils
Doxygen code documentation for the python framework controlling openCARP
Public Member Functions | List of all members
carputils.mesh.region.BoxRegion Class Reference

Describe an axis-aligned cuboid for mesh tag assignment. More...

Inheritance diagram for carputils.mesh.region.BoxRegion:
carputils.mesh.region.Region

Public Member Functions

def __init__ (self, lowerleft=(0., 0., 0), upperright=(0., 0., 0.), tag=None, bath=0)
 
def __call__ (self, coord)
 
- 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...
 

Additional Inherited Members

- Public Attributes inherited from carputils.mesh.region.Region
 tag
 
 bath
 
 rtype
 
 radius
 
 p0
 
 p1
 
 ctype
 

Detailed Description

Describe an axis-aligned cuboid for mesh tag assignment.

Note
!!!mesher assumes the boxes to be relative to the center of the mesh!!!
Parameters
lowerleftarray-like, optional Lower left corner of the box region, defaults to (0,0,0)
upperrightarray-like, optional Upper right corner of the box region, defaults to (0,0,0)
tagint, optional Tag ID to assign to this region, defaults to auto assign by mesher
bathint, optional
0no bath, 1 - isotropic bath, 2 - anisotropic bath, default is 0

Constructor & Destructor Documentation

◆ __init__()

def carputils.mesh.region.BoxRegion.__init__ (   self,
  lowerleft = (0., 0., 0),
  upperright = (0., 0., 0.),
  tag = None,
  bath = 0 
)

Member Function Documentation

◆ __call__()

def carputils.mesh.region.BoxRegion.__call__ (   self,
  coord 
)

The documentation for this class was generated from the following file: