Statoil

class Statoil[source]

Bases: openpnm.io.GenericIO.GenericIO

The StatOil format is used by the Maximal Ball network extraction code of the Imperial College London group

This class can be used to load and work with those networks. Numerous datasets are available for download from the group’s website.

The ‘Statoil’ format consists of 4 different files in a single folder. The data is stored in columns with each corresponding to a specific property. Headers are not provided in the files, so one must refer to various theses and documents to interpret their meaning.

classmethod add_reservoir_pore(network, pores, offset=0.1)[source]
Parameters
  • network (OpenPNM Network object) – The network to which the reservoir pore should be added

  • pores (array_like) – The pores to which the reservoir pore should be connected to

  • offset (scalar) – Controls the distance which the reservoir is offset from the given pores. The total displacement is found from the network dimension normal to given pores, multiplied by offset.

classmethod export_data(network, shape, prefix=None, path=None, Pin=None, Pout=None)[source]
Parameters
  • network (OpenPNM Network object) – The network

  • shape (array_like) – An ndim-by-1 array or list containing the network dimensions in physical units (i.e. um)

  • prefix (str) – The prefix to append to each file name, such as <prefix>_node1.dat. If not provided project.name is used.

  • path (str or path object) – The location where the exported files should be stored. If not provided the current working directory is used

  • Poutlet (Pinlet and) – The pore index of the inlet and outlet reservoir pores. If not provided then it is assumed they are the second last and last pores in the network, respectively. This would be the case if the add_reservoir_pore function had been called prior to exporting.

classmethod import_data(path, prefix, network=None)[source]

Load data from the 'dat' files located in specified folder.

Parameters
  • path (string) – The full path to the folder containing the set of 'dat' files.

  • prefix (string) – The file name prefix on each file. The data files are stored as <prefix>_node1.dat.

  • network (OpenPNM Network Object) – If given then the data will be loaded on it and returned. If not given, a Network will be created and returned.

Returns

Return type

An OpenPNM Project containing a GenericNetwork holding all the data

classmethod load(*args, **kwargs)[source]

This method is being deprecated. Use import_data instead.