Muscat.IO.SamcefOutputReader module

Samcef output file reader

CheckIntegrity()

ReadFieldFromDataBase(fieldname, field, time=None)

Function API for reading a field in a samcef output file

Parameters:

• fieldname (str) – name of the file to be read

• field (str) – name of the field to read in the file

• time (float, optional) – time at which the data is read, by default None

Returns:

indices and values of the field to read

Return type:

np.ndarray, np.ndarray

class SamcefData(arg1=' ', arg2=' ', arg3=' ', arg4=' ', name=' ', nbcomp=1)

Bases: object

GetArgs()

class SamcefDataE(*k, **nk)

Bases: SamcefData

class SamcefDataG(*k, **nk)

Bases: SamcefData

class SamcefDataN(*k, **nk)

Bases: SamcefData

class SamcefOuputReader

Bases: object

Samcef output Reader class

Close(needToClose=True)

GetAvailableTimes()

Returns available times to read

Returns:

time values available to read

Return type:

list

Open()

OpenIfNeeded()

Read()

Function that performs the reading of a samcef output file

Returns:

output unstructured mesh object containing reading result

Return type:

Mesh

ReadField(fieldname=None, time=None, timeIndex=None)

Function that performs the reading of a field in a samcef output file

Parameters:

• fieldname (str, optional) – name of the field to read, by default None

• time (float, optional) – time at which the data is read, by default None

• timeIndex (int, optional) – time index which the data is read, by default None

Returns:

indices and values of the field to read

Return type:

np.ndarray, np.ndarray

ReadMetaData()

Function that performs the reading of the metadata of a samcef output file

SetFileName(fileName)

Sets the name of the file to read

Parameters:

fileName (str) – name of the file to read

SetTimeToRead(time=None, timeIndex=None)

Sets the time at which the data is read

Parameters:

• time (float, optional) – time at which the data is read, by default None

• timeIndex (int, optional) – time index which the data is read, by default None