Muscat.IO.CGNSReader module

CGNS file reader

class CGNSReader

Bases: object

CGNS Reader class

GetExtraAvailableFields() → List[Tuple[str, FieldSupports]]

return a list of tuples of (field name,field support)

Read(fileName: str | None = None, time: float64 | None = None) → Mesh

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

ReadExtraFields(query: List[Tuple[str, FieldSupports]]) → Dict[Tuple[str, FieldSupports], ndarray | FEField | IPField]

query is of the same type (structure) of the output of GetExtraFieldsAvailable

and the output is a dict with keys of type of every entry of query, and the value the actual field

SetFileName(fileName: str | None) → None

Function to set fileName to read

Parameters:

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

SetTimeToRead(time: float64 | None = None) → None

Function to set time value to read

Parameters:

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

CheckIntegrity(GUI: bool = False)

ReadCGNS(fileName, time: float64 | None = None, baseNumberOrName: int64 | str = np.int64(0), zoneNumberOrName: int64 | str = np.int64(0), keepPartitionedMesh=False) → Mesh

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