butterfly.surfaceFeatureExtractDict module

Finite Volume Solution class.

class butterfly.surfaceFeatureExtractDict.SurfaceFeatureExtractDict(values=None)

Bases: butterfly.foamfile.FoamFile

surfaceFeatureExtractDict class.

classmethod from_file(filepath)

Create a FoamFile from a file.

Parameters:filepath – Full file path to dictionary.

classmethod from_stl_file(file_name, extractionMethod='extractFromSurface', includedAngle=150, geometricTestOnly=True, writeObj=False)

Generate fvSolution for a particular recipe.

Parameters:

• file_name – stl file name (e.g. project.stl)
• extractionMethod – Indicate how to obtain raw features. extractFromFile or extractFromSurface
• includedAngle – An integer for the max angle between the faces to be considered as two different faces and so the edge between them will be considered as an edge. 0 > selects no edges and 180 > selects all edges (default: 150).
• geometricTestOnly – A Boolean (default: True).
• writeObj – A Boolean to write features to obj format for postprocessing. (default: False)