BasicTools.IO.SamcefOutputReader module

Samcef output file reader

BasicTools.IO.SamcefOutputReader.CheckIntegrity()[source]
BasicTools.IO.SamcefOutputReader.ReadFieldFromDataBase(fieldname, field, time=None)[source]

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 BasicTools.IO.SamcefOutputReader.SamcefData(arg1=' ', arg2=' ', arg3=' ', arg4=' ', name=' ', nbcomp=1)[source]

Bases: object

GetArgs()[source]
class BasicTools.IO.SamcefOutputReader.SamcefDataE(*k, **nk)[source]

Bases: SamcefData

class BasicTools.IO.SamcefOutputReader.SamcefDataG(*k, **nk)[source]

Bases: SamcefData

class BasicTools.IO.SamcefOutputReader.SamcefDataN(*k, **nk)[source]

Bases: SamcefData

class BasicTools.IO.SamcefOutputReader.SamcefOuputReader[source]

Bases: BaseOutputObject

Samcef output Reader class

Close(needToClose=True)[source]
GetAvailableTimes()[source]

Returns available times to read

Returns:

time values available to read

Return type:

list

Open()[source]
OpenIfNeeded()[source]
Read()[source]

Function that performs the reading of a samcef output file

Returns:

output unstructured mesh object containing reading result

Return type:

UnstructuredMesh

ReadField(fieldname=None, time=None, timeIndex=None)[source]

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()[source]

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

SetFileName(fileName)[source]

Sets the name of the file to read

Parameters:

fileName (str) – name of the file to read

SetTimeToRead(time=None, timeIndex=None)[source]

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