carputils.mesh.region.Region Class Reference

A general region definition. More...

Inheritance diagram for carputils.mesh.region.Region:

Public Member Functions
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
	tag
	bath
	rtype
	radius
	p0
	p1
	ctype

Detailed Description

A general region definition.

Do not use directly. Use :class:BoxRegion, :class:SphereRegion or :class:CylinderRegion instead.

Parameters

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
p0	array-like, optional Relevant point 0, in mm
p1	array-like, optional Relevant point 1, in mm
radius	float Radius, where relevant, in mm
rtype	int region type identifier for mesher
ctype	int region type identifier for carp

Constructor & Destructor Documentation

__init__()

def carputils.mesh.region.Region.__init__	(		self,
			tag = None,
			bath = 0,
			rtype = 0,
			p0 = (0., 0., 0.),
			p1 = (0., 0., 0.),
			radius = 0.,
			ctype = None
	)

Member Function Documentation

__call__()

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

Reimplement with logic determining if coord (mm) is in the region.

Reimplemented in carputils.mesh.region.CylinderRegion, carputils.mesh.region.SphereRegion, and carputils.mesh.region.BoxRegion.

carp_opts()

def carputils.mesh.region.Region.carp_opts	(		self,
			i
	)

Generate the carp option list for this tag region.

Parameters

i	int Index of mesh region.

Returns

list Mesher command line options for this region.

Reimplemented in carputils.mesh.region.CylinderRegion.

mesher_opts()

def carputils.mesh.region.Region.mesher_opts	(		self,
			i
	)

Generate the mesher option list for this region.

Parameters

i	int Index of mesh region.

Returns

list Mesher command line options for this region.

Reimplemented in carputils.mesh.region.CylinderRegion.

Member Data Documentation

bath

carputils.mesh.region.Region.bath

ctype

carputils.mesh.region.Region.ctype

p0

carputils.mesh.region.Region.p0

p1

carputils.mesh.region.Region.p1

radius

carputils.mesh.region.Region.radius

rtype

carputils.mesh.region.Region.rtype

tag

carputils.mesh.region.Region.tag

---

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

• carputils/mesh/region.py