PLaSK User Manual

RefractiveIndexFilter3D Class

class plask.flow.RefractiveIndexFilter3D(geometry)

Data filter for refractive index into Cartesian3D geometry.

Parameters:geometry (geometry.Cartesian3D) – Target geometry.

See also

plask.filter for details on filter usage.

Methods

initialize() Initialize solver.
invalidate() Set the solver back to uninitialized state.
load_xpl(xpl, manager) Load configuration from XPL reader.

Attributes

id Id of the solver object.
initialized True if the solver has been initialized.
out Filter output provider.
outRefractiveIndex Filter output provider.

Descriptions

Method Details

RefractiveIndexFilter3D.initialize()

Initialize solver.

This method manually initialized the solver and sets initialized to True. Normally calling it is not necessary, as each solver automatically initializes itself when needed.

Returns:solver initialized state prior to this method call.
Return type:bool
RefractiveIndexFilter3D.invalidate()

Set the solver back to uninitialized state.

This method frees the memory allocated by the solver and sets initialized to False.

RefractiveIndexFilter3D.load_xpl(xpl, manager)

Load configuration from XPL reader.

This method should be overriden in custom Python solvers.

Example

def load_xpl(self, xpl, manager):
    for tag in xpl:
        if tag == 'config':
            self.a = tag['a']
            self.b = tag.get('b', 0)
            if 'c' in tag:
                self.c = tag['c']
        if tag == 'combined':
            for subtag in tag:
                if subtag == 'withtext':
                    self.data = subtag.attrs
                    # Text must be read last
                    self.text = subtag.text
        elif tag == 'geometry':
            self.geometry = tag.getitem(manager.geo, 'ref')

Attribute Details

RefractiveIndexFilter3D.id

Id of the solver object. (read only)

Example

>>> mysolver.id
mysolver:category.type
RefractiveIndexFilter3D.initialized

True if the solver has been initialized. (read only)

Solvers usually get initialized at the beginning of the computations. You can clean the initialization state and free the memory by calling the invalidate() method.

RefractiveIndexFilter3D.out

Filter output provider.

Example

>>> some_solver.inRefractiveIndex = my_filter.outRefractiveIndex
RefractiveIndexFilter3D.outRefractiveIndex

Filter output provider.

Example

>>> some_solver.inRefractiveIndex = my_filter.outRefractiveIndex