Muscat.IO.CGNSReader module

CGNS file reader

class CGNSReader[source]

Bases: object

CGNS Reader class

Read(fileName: str | None = None, time: float64 | None = None) → Mesh[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:

Mesh

SetFileName(fileName: str) → None[source]

Function to set fileName to read

Parameters:

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

SetTimeToRead(time: float64 | None = None) → None[source]

Function to set time value to read

Parameters:

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

CheckIntegrity(GUI: bool = False)[source]
ReadCGNS(fileName, time: float64 | None = None, baseNumberOrName: int64 | str = 0, zoneNumberOrName: int64 | str = 0) → Mesh[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:

Mesh