write_size_field#

FileIO.write_size_field(file_name, params)#

Write a PyPrimeMesh size field (PSF) file to a file on disk.

Parameters:
file_namestr

Path to the size field file on disk.

paramsWriteSizeFieldParams

Parameters for writing the size field file.

Returns:
FileWriteResults

Results from writing the size field file.

Return type:

FileWriteResults

Notes

This method does not support Unicode paths.

Examples

>>> file_io = prime.FileIO(model=model)
>>> params = prime.WriteSizeFieldParams(model=model)
>>> results = file_io.write_size_field("/tmp/my_prime_sizefield.psf", params)