PLaSK User Manual

Cartesian3D Class

class plask.geometry.Cartesian3D(geometry, **edges)

Geometry in 3D space.

Create a space around a two-dimensional geometry object.
Parameters:
  • root (GeometryObject3D) – Root object of the geometry.
  • edges (dict) – Optional edges specification. Edges are given as additional constructor keyword arguments. Available keys are back, front, left, right, top, and bottom and their values must be strings specifying the edge (either a material name or mirror, periodic, or extend).

Example

>>> block = geometry.Block3D(4, 2, 1, 'GaAs')
>>> geometry.Cartesian3D(block, left='mirror', bottom='GaAs',
...                      front='periodic', back='periodic')
<plask.geometry.Cartesian3D object at (0x3dd6c70)>

Methods

get_grid() Get rectangular grid for space.
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_material_field(mesh) Distribution of materials for a given geometry on a mesh.
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.

Attributes

axes Names of axes for this geometry.
bbox Minimal rectangle which contains all points of the geometry object.
default_material Material of the empty regions of the geometry.
dims Number of object’s dimensions (int, 2 or 3).
edges Dictionary specifying the geometry edges.
item GeometryObject3D at the root of the geometry tree.
steps Step info for mesh generation for non-uniform objects.

Descriptions

Method Details

Cartesian3D.get_grid()

Get rectangular grid for space.

Return rectangular mesh that has lines along the edges of all the geometry objects. In some objects are non-rectangular or non-uniform, they are divided according to their settings.

Cartesian3D.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().

Cartesian3D.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.

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().

Cartesian3D.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.

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().

Cartesian3D.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.

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().

Cartesian3D.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
Cartesian3D.get_material(point)
Cartesian3D.get_material(c0, c1, c2)

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 default_material.

Parameters:
  • point (plask.vector) – Vector with local coordinates of the tested point.
  • c0 (float) – Longitudinal coordinate of the tested point.
  • c1 (float) – Transverse coordinate of the tested point.
  • c2 (float) – Vertical coordinate of the tested point.
Returns:

Material at the specified point.

Cartesian3D.get_material_field(mesh)

Distribution of materials for a given geometry on a mesh.

This class creates a ‘field’ of material.Material objects and provides getters to easily obtain its properties as Data object.

Parameters:
  • geometry – Geometry for which the materials a retrieved
  • mesh – Mesh at which the parameters are retrieved

Example

>>> material_field = this_geometry.get_material_field(your_mesh)
>>> plot_field(material_field.thermk(300.), comp=0)
Cartesian3D.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:
  • object – Object to test.
  • path – Path specifying a particular object instance.
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()

Cartesian3D.get_object_positions(object, path=None)

Calculate positions of all instances of the specified object.

Parameters:
  • object – Object to test.
  • path – Path specifying a particular object instance.
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()

Cartesian3D.get_paths(c0, c1, c2, all=False)
Cartesian3D.get_paths(point, all=False)

Get subtree containing paths to all leafs covering the specified point.

Parameters:
  • point (plask.vector) – Vector with local coordinates of the tested point.
  • c0 (float) – Longitudinal coordinate of the tested point.
  • c1 (float) – Transverse coordinate of the tested point.
  • c2 (float) – Vertical coordinate of the tested point.
  • all (bool) – If True then all the leafs intersecting the point are considered. Otherwise, only the path to the topmost (i.e. visible) object is returned.
Returns:

Subtree with the path to the specified point.

Cartesian3D.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
Cartesian3D.get_roles(point)
Cartesian3D.get_roles(c0, c1, c2)

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:
  • point (plask.vector) – Vector with local coordinates of the tested point.
  • c0 (float) – Longitudinal coordinate of the tested point.
  • c1 (float) – Transverse coordinate of the tested point.
  • c2 (float) – Vertical coordinate of the tested point.
Returns:

Set of the roles at given point.

Return type:

set

Cartesian3D.has_role(role, point)
Cartesian3D.has_role(role, c0, c1, c2)

Test if the specified point has a given role.

This method checks if any object intersecting the specified point has the role role.

Parameters:
  • point (plask.vector) – Vector with local coordinates of the tested point.
  • c0 (float) – Longitudinal coordinate of the tested point.
  • c1 (float) – Transverse coordinate of the tested point.
  • c2 (float) – Vertical coordinate of the tested point.
  • mesh (plask.mesh.Mesh) – Mesh, which points are tested.
Returns:

True if the point has the role role.

If a mesh is tested, the return value is an array of bools.

Return type:

bool

Cartesian3D.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
Cartesian3D.object_contains(object, path, mesh)
Cartesian3D.object_contains(object, c0, c1, c2)
Cartesian3D.object_contains(object, path, point)
Cartesian3D.object_contains(object, point)
Cartesian3D.object_contains(object, path, c0, c1, c2)
Cartesian3D.object_contains(object, mesh)

Test if the specified geometry object contains a point.

The given geometry object must be located somewhere within the self geometry tree.

Parameters:
  • object – Object to test.
  • path – Path specifying a particular object instance.
  • point (plask.vector) – Vector with local coordinates of the tested point.
  • c0 (float) – Longitudinal coordinate of the tested point.
  • c1 (float) – Transverse coordinate of the tested point.
  • c2 (float) – Vertical coordinate of the tested point.
Returns:

True if the specified geometry object contains the given point.

Return type:

bool

Cartesian3D.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.

Attribute Details

Cartesian3D.axes

Names of axes for this geometry.

Cartesian3D.bbox

Minimal rectangle which contains all points of the geometry object.

Cartesian3D.default_material

Material of the empty regions of the geometry.

This material is returned by get_material() for the points that do not belong to any object in the geometry tree.

Cartesian3D.dims

Number of object’s dimensions (int, 2 or 3).

Cartesian3D.edges

Dictionary specifying the geometry edges.

Cartesian3D.item

GeometryObject3D at the root of the geometry tree.

Cartesian3D.steps

Step info for mesh generation for non-uniform objects.

This parameter is considered only for the non-uniform 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 non-uniform object be subdivided.

It is possible to assign simply an integer number to this parameter, in which case it changes its num attribute.