BasicTools.IO.GeofReader module

Geof file reader (Zset mesh file)

BasicTools.IO.GeofReader.CheckIntegrity()[source]
class BasicTools.IO.GeofReader.GeofReader[source]

Bases: ReaderBase

Geof Reader class

Read(fileName=None, string=None, out=None, readElset=True, readFaset=True, printNotRead=True)[source]

Function that performs the reading of a geof mesh file

Parameters:
  • fileName (str, optional) – name of the file to be read, by default None

  • string (str, optional) – data to be read as a string instead of a file, by default None

  • out (UnstructuredMesh, optional) – output unstructured mesh object containing reading result, by default None

  • readElset (bool, optional) – if False, ignores the elset informations, by default True

  • readFaset (bool, optional) – if False, ignores the faset informations, by default True

  • printNotRead (bool, optional) – if True, prints in console the lines dot understood by the reader, by default True

Returns:

output unstructured mesh object containing reading result

Return type:

UnstructuredMesh

ReadMetaData()[source]

Function that performs the reading of the metadata of a geof mesh file

Returns:

global information on the mesh to read

Return type:

dict

BasicTools.IO.GeofReader.ReadGeof(fileName=None, string=None, out=None, readElset=True, readFaset=True, printNotRead=True)[source]

Function API for reading a geof mesh file

Parameters:
  • fileName (str, optional) – name of the file to be read, by default None

  • string (str, optional) – data to be read as a string instead of a file, by default None

  • out (UnstructuredMesh, optional) – output unstructured mesh object containing reading result, by default None

  • readElset (bool, optional) – if False, ignores the elset informations, by default True

  • readFaset (bool, optional) – if False, ignores the faset informations, by default True

  • printNotRead (bool, optional) – if True, prints in console the lines dot understood by the reader, by default True

Returns:

output unstructured mesh object containing reading result

Return type:

UnstructuredMesh

BasicTools.IO.GeofReader.ReadMetaData(fileName=None, string=None)[source]

Function API for reading the metadata of a geof mesh file

Parameters:
  • fileName (str, optional) – name of the file to be read, by default None

  • string (str, optional) – data to be read as a string instead of a file, by default None

Returns:

global information on the mesh to read

Return type:

dict