butterfly.sampleDict module

sampleDict class.

class butterfly.sampleDict.SampleDict(values=None)[source]

Bases: butterfly.foamfile.Condition

Probes function.

fields

Get and set probes fields from list of tuples.

filename

Get SampleDict filename.

classmethod from_file(filepath)[source]

Create a FoamFile from a file.

Parameters:filepath – Full file path to dictionary.
classmethod from_points(name, points, fields)[source]

Create sampleDict from points and fields.

output_filenames

A tuple of output file names.

points

Get and set probe locations from list of tuples.

points_count

Get number of probes.

save(project_folder, sub_folder=None)[source]

Save sampleDict file.

The file will be named