plask.geometry.
Extrusion
(item, length=infinity)¶Extrusion in the longitudinal direction of the 2D object into a 3D one.
Objects of this type can be supplied to 2D Cartesian solvers or they can be used as a part of the 3D geometry tree.
Parameters: 


Example
Instead of using Cuboid
object, you can extrude
a rectangle in the following way:
>>> rect = plask.geometry.Rectangle(2, 3, 'GaAs')
>>> cuboid = plask.geometry.Extrusion(rect, 1)
The created cuboid will have dimensions 1µm, 2µm, and 3µm along logitudinal, transverse, and vertical axes, respectively.
Note: In the reallife situations, you can extrude any complicated 2D object (e.g. a stack of a shelf).
contains (…) 
Test if the geometry object contains a point. 
get_leafs ([path]) 
Get list of the geometry tree leafs. 
get_leafs_bboxes ([path]) 
Calculate bounding boxes of all the geometry tree leafs. 
get_leafs_positions ([path]) 
Calculate positions of all the geometry tree leafs. 
get_leafs_translations ([path]) 
Get list of Translation objects holding all the geometry tree leafs. 
get_matching_objects (cond) 
Get list of the geometry tree objects matching condition. 
get_material (…) 
Get material at the given point. 
get_object_bboxes (object[, path]) 
Calculate bounding boxes of all instances of specified object. 
get_object_positions (object[, path]) 
Calculate positions of all instances of the specified object. 
get_paths (…) 
Get subtree containing paths to all leafs covering the specified point. 
get_role_objects (role) 
Get list of the geometry tree objects that have the specified role. 
get_roles (…) 
Get roles of objects at specified point. 
has_role (…) 
Test if the specified point has a given role. 
modify_objects (callable) 
Modify all objects in the geometry tree. 
object_contains (…) 
Test if the specified geometry object contains a point. 
validate () 
Check if the object is complete and ready for calculations. 
bbox 
Minimal rectangle which contains all points of the geometry object (in local coordinates). 
dims 
Number of object’s dimensions (int, 2 or 3). 
item 
Transformed 2D object. 
length 
Length of the extrusion in the longitudinal direction. 
role 
Role of the object. 
roles 
List of all the roles of the object. 
steps 
Step info for mesh generation for nonuniform objects. 
Extrusion.
contains
(c0, c1, c2)¶Extrusion.
contains
(point)Test if the geometry object contains a point.
Parameters: 


Returns:  True if the geometry object contains the given point. 
Return type:  bool 
Extrusion.
get_leafs
(path=None)¶Get list of the geometry tree leafs.
This method returns all the geometry tree leafs located under this geometry object. By leaf we understand a proper geometry object, in contrast to any container or transformation.
Parameters:  path – Path that can be used to select only some leafs. 

Returns:  List of translations of the leafs. 
Return type:  sequence 
All these methods are guaranteed to return their sequences in the same order:
get_leafs()
,
get_leafs_bboxes()
,
get_leafs_positions()
,
get_leafs_translations()
.
Extrusion.
get_leafs_bboxes
(path=None)¶Calculate bounding boxes of all the geometry tree leafs.
This method computes the bounding boxes of all the geometry tree leafs located under this geometry object. By leaf we understand a proper geometry object, in contrast to any container or transformation.
The bounding boxes are computed in the local coordinates of this object.
Parameters:  path – Path that can be used to select only some leafs. 

Returns:  List of vectors containing the position of the leafs. 
Return type:  sequence 
All these methods are guaranteed to return their sequences in the same order:
get_leafs()
,
get_leafs_bboxes()
,
get_leafs_positions()
,
get_leafs_translations()
.
Extrusion.
get_leafs_positions
(path=None)¶Calculate positions of all the geometry tree leafs.
This method computes position of all the geometry tree leafs located under this geometry object. By leaf we understand a proper geometry object, in contrast to any container or transformation.
The position are computed in the local coordinates of this object.
Parameters:  path – Path that can be used to select only some leafs. 

Returns:  List of vectors containing the position of the leafs. 
Return type:  sequence 
All these methods are guaranteed to return their sequences in the same order:
get_leafs()
,
get_leafs_bboxes()
,
get_leafs_positions()
,
get_leafs_translations()
.
Extrusion.
get_leafs_translations
(path=None)¶Get list of Translation
objects holding all the geometry tree leafs.
This method computes the Translation
objects of all the geometry tree
leafs located under this geometry object. By leaf we understand a proper
geometry object, in contrast to any container or transformation.
The translations are computed in the local coordinates of this object.
Parameters:  path – Path that can be used to select only some leafs. 

Returns:  List of translations of the leafs. 
Return type:  sequence 
All these methods are guaranteed to return their sequences in the same order:
get_leafs()
,
get_leafs_bboxes()
,
get_leafs_positions()
,
get_leafs_translations()
.
Extrusion.
get_matching_objects
(cond)¶Get list of the geometry tree objects matching condition.
This method returns all the objects in the geometry tree that match the specified condition.
Parameters:  cond – Python callable that accepts a geometry object and returns Boolean indicating whether the object should be returned by this method or not. 

Returns:  List of objects matching your condition. 
Return type:  sequence 
Extrusion.
get_material
(c0, c1, c2)¶Extrusion.
get_material
(point)Get material at the given point.
This method returns a material object with the material at the given point if this point is located within the geometry object self. Otherwise the method returns None.
Parameters: 


Returns:  Material at the specified point or None. 
Extrusion.
get_object_bboxes
(object, path=None)¶Calculate bounding boxes of all instances of specified object.
The bounding boxes are computed in the local coordinates of self.
Parameters: 


Returns:  List of bounding boxes of the instances of the object. 
Return type:  sequence 
All these methods are guaranteed to return their sequences in the same order,
provided they are called with the same arguments:
get_object_bboxes()
,
get_object_positions()
Extrusion.
get_object_positions
(object, path=None)¶Calculate positions of all instances of the specified object.
The position are computed in the local coordinates of self.
Parameters: 


Returns:  List of vectors containing the position of the instances of the object. 
Return type:  sequence 
All these methods are guaranteed to return their sequences in the same order,
provided they are called with the same arguments:
get_object_bboxes()
,
get_object_positions()
Extrusion.
get_paths
(c0, c1, c2, all=False)¶Extrusion.
get_paths
(point, all=False)Get subtree containing paths to all leafs covering the specified point.
Parameters: 


Returns:  Subtree with the path to the specified point. 
See also
Extrusion.
get_role_objects
(role)¶Get list of the geometry tree objects that have the specified role.
This method returns all the objects in the geometry tree that have the specified role.
Warning
This method will return the very object with the role specified and not its items, which is against the normal behavior of the roles.
Parameters:  role (str) – Role to search objects with. 

Returns:  List of objects matching your condition. 
Return type:  sequence 
Extrusion.
get_roles
(c0, c1, c2)¶Extrusion.
get_roles
(point)Get roles of objects at specified point.
This method returns a set of all the roles given to the every object intersecting the specified point.
Parameters: 


Returns:  Set of the roles at given point. 
Return type:  set 
Extrusion.
has_role
(role, c0, c1, c2)¶Extrusion.
has_role
(role, point)Test if the specified point has a given role.
This method checks if any object intersecting the specified point has the role role.
Parameters: 


Returns:  True if the point has the role role. 
Return type:  bool 
Extrusion.
modify_objects
(callable)¶Modify all objects in the geometry tree.
This method calls callable
on every object in the geometry tree.
The callable
takes a single geometry object as an argument and should
return None
(in which case nothing happens), a new object to replace
the original one, or an empty tuple (which will result in the removal of
the original object).
Parameters:  callable – a callable filtering each object in the tree 

Returns:  modified geometry 
Return type:  GeometryObject 
Extrusion.
object_contains
(object, c0, c1, c2)¶Extrusion.
object_contains
(object, mesh)Extrusion.
object_contains
(object, path, c0, c1, c2)Extrusion.
object_contains
(object, path, mesh)Extrusion.
object_contains
(object, path, point)Extrusion.
object_contains
(object, point)Test if the specified geometry object contains a point.
The given geometry object must be located somewhere within the self geometry tree.
Parameters: 


Returns: 

Return type:  bool 
Extrusion.
validate
()¶Check if the object is complete and ready for calculations.
This method is specific for a particular object. It raises an exception if the object definition is somehow incomplete.
Extrusion.
bbox
¶Minimal rectangle which contains all points of the geometry object (in local coordinates).
See also
Extrusion.
dims
¶Number of object’s dimensions (int, 2 or 3).
Extrusion.
item
¶Transformed 2D object.
Extrusion.
length
¶Length of the extrusion in the longitudinal direction.
Extrusion.
role
¶Role of the object. Valid only if the object has only one role.
Extrusion.
roles
¶List of all the roles of the object.
Extrusion.
steps
¶Step info for mesh generation for nonuniform objects.
This parameter is considered only for the nonuniform leafs in the geometry tree. It has two attributes that can be changed:
num 
Maximum number of the mesh steps in each direction the object is divided into. 
dist 
Minimum step size. 
The exact meaning of these attributes depend on the mesh generator, however in general they indicate how densely should the nonuniform object be subdivided.
It is possible to assign simply an integer number to this parameter, in which
case it changes its num
attribute.