General Functions

Input / Output

Pickle binary

pysimfrac.src.io.dump_pickle.to_pickle(self, pickle_filename)[source]

Saves the DFN object into a pickle format

Parameters:

  • Object (SimFrac) –

  • pickle_filename (string) – Name of file.

Return type:

None

Notes

None

myFrac.to_pickle('myfrac.pkl')
pysimfrac.src.io.dump_pickle.from_pickle(self, filename)[source]

Loads the simfrac object from a pickle format

Parameters:

  • self (simfrac Object) –

  • filename (string) – name of pickle DFN object

Return type:

simfrac object

Notes

myFrac = SimFrac(pickle_file = "myfrac.pkl" )

ASCII

pysimfrac.src.io.dump_ascii.dump_ascii(self, surface='all', filename_prefix=None, coordinates=False, indices=False)[source]

Writes a surface fields to ascii files.

Parameters:

  • self (object) – simFrac Class

  • surface (str) – Named of desired surface to write to file. Options are ‘aperture’, ‘top’, ‘bottom’, and ‘all’(default).

  • filename_prefix (str) – Prefix for filename

  • coordinates (bool) – True / False to write x/y coordinates to file

  • indices (bool) – True / False to write i/j indices to file

Return type:

None

Notes

Files written out are aperture.dat, top.dat, and bottom.dat

myFrac.dump_ascii(surface = 'all', filename_prefix = 'myfrac', coordinates = True)