microstructpy.geometry.factory

geometry.factory(**kwargs)

Factory method for geometries.

This function returns a geometry based on a string containing the name of the geometry and keyword arguments defining the geometry.

Note

The function call is factory(name, **kwargs). Sphinx autodocs has dropped the first parameter.

Parameters:

• name (str) – {‘box’ | ‘cube’ | ‘ellipse’ | ‘ellipsoid’ | ‘circle’ | ‘rectangle’ | ‘square’ | ‘sphere’} Name of geometry.

• **kwargs (dict) – Arguments defining the geometry.