BasicTools.IO.CGNSReader module

CGNS file reader

class BasicTools.IO.CGNSReader.CGNSReader[source]

Bases: BaseOutputObject

CGNS Reader class

Read(fileName=None, time=None)[source]

Function that performs the reading of a CGNS result file

Parameters:
  • fileName (str) – name of the file to be read

  • time (float, optional) – not coded yet, by default None

  • baseNumberOrName (int or str, optional) – name of the base to use, by default 0 (first)

  • zoneNumberOrName (int or str, optional) – name of the zone to be read, by default 0 (first)

Returns:

output unstructured mesh object containing reading result

Return type:

UnstructuredMesh

SetFileName(fileName)[source]

Function to set fileName to read

Parameters:

fileName (str) – name of the file to be read

SetTimeToRead(time=None)[source]

Function to set time value to read

Parameters:

time (float, optional) – not coded yet, by default None

BasicTools.IO.CGNSReader.CheckIntegrity(GUI=False)[source]
BasicTools.IO.CGNSReader.ReadCGNS(fileName, time=None, baseNumberOrName=0, zoneNumberOrName=0)[source]

Function API for reading a CGNS file

Parameters:
  • fileName (str) – name of the file to be read

  • time (float, optional) – not coded yet, by default None

  • baseNumberOrName (int or str, optional) – name of the base to use, by default 0 (first)

  • zoneNumberOrName (int or str, optional) – name of the zone to be read, by default 0 (first)

Returns:

output unstructured mesh object containing reading result

Return type:

UnstructuredMesh