Muscat.IO.XdmfReader module

Xdmf file reader

CheckIntegrity()

Example1()

Example2()

ReadXdmf(fileName)

Function API for reading an xdmf file

Parameters:

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

Returns:

output unstructured mesh object containing reading result

Return type:

Mesh

class Xdmf

Bases: XdmfBase

Top class for the xdmf Document

GetDomain(nameOrNumber: str | int64) → XdmfDomain

Get a Grid (XdmfGrid) using a name or a number

class XdmfAttribute

Bases: XdmfBase

XdmfAttribute class: to store the data over the grids

ReadAttributes(attrs)

class XdmfBase

Bases: object

Base class for all the xdmf related objects

ReadAttribute(attrs, name, default=None)

“ Helper to read attributes

TreatCDATA() → None

Default implementation to read the heavy data

class XdmfDataItem

Bases: XdmfBase

XdmfDataItem class : class to manage the reading of the data Heavy and light

GetData()

ReadAttributes(attrs, path)

TreatCDATA()

Default implementation to read the heavy data

class XdmfDomain

Bases: XdmfBase

A Domain. Can contain many grids

GetGrid(NameOrNumber: str | int64) → XdmfGrid

Get a Grid (XdmfGrid) using a name or a number

ReadAttributes(attrs)

class XdmfGeometry

Bases: XdmfBase

XdmfGeometry class: stores the point positions

GetNodes() → np.ndarray

GetOrigin() → np.ndarray

GetSpacing() → np.ndarray

ReadAttributes(attrs)

class XdmfGrid

Bases: XdmfBase

a Grid: contains a mesh (points and connectivity ) and fields by (element, nodes, grid)

GetCellField(name) → List[np.ndarray]

GetCellFields() → List[np.ndarray]

GetCellFieldsNames() → List[str]

GetFieldData(name, noTranspose=False)

GetFieldTermsAsColMatrix(fieldname, offset=0)

GetFieldTermsAsTensor(fieldname, sep='_', offseti=0, offsetj=0)

GetFieldsNames()

GetFieldsOfType(ftype, name=None)

GetGridField(name) → List[np.ndarray]

GetGridFields() → List[np.ndarray]

GetGridFieldsNames() → List[str]

GetPointField(name) → List[np.ndarray]

GetPointFields() → List[np.ndarray]

GetPointFieldsNames() → List[str]

GetSupport() → Mesh

Returns the support defined in the Xdmf file

Returns:

output mesh object containing reading result

Return type:

Mesh or ConstantRectilinearMesh

GetTime()

Returns time at which data is read

Returns:

time at which data is read

Return type:

float

HasField(name)

ReadAttributes(attrs)

class XdmfInformation

Bases: XdmfBase

class for extra information in the xmdf file

ReadAttributes(attrs)

class XdmfReader(filename='')

Bases: ContentHandler

Xdmf Reader class

GetAvailableTimes()

Returns the available times at which data can be read

Returns:

available times at which data can be read

Return type:

np.ndarray

Read(fileName=None)

Function that performs the reading of the data defined in an ut file

Parameters:

fileName (str, optional) – name of the file to read, by default None

Returns:

output mesh object containing reading result

Return type:

Mesh or ConstantRectilinearMesh

ReadMetaData()

Function that performs the reading of the metadata of a xdmf file: sets the time attribute of the reader

Reset()

Resets the reader

SetFileName(filename)

Sets the name of file to read

Parameters:

filename (str) – file name to set

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 at which the data is read, by default None

Returns:

time index at which the data is read

Return type:

int

characters(content)

Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.

endElement(name)

Signals the end of an element in non-namespace mode.

The name parameter contains the name of the element type, just as with the startElement event.

startElement(name, attrs)

Signals the start of an element in non-namespace mode.

The name parameter contains the raw XML 1.0 name of the element type as a string and the attrs parameter holds an instance of the Attributes class containing the attributes of the element.

class XdmfTime

Bases: XdmfBase

XdmfTime class: to store the data over the grids

ReadAttributes(attrs)

class XdmfTopology

Bases: XdmfBase

XdmfTopology class: stores the connectivity of the Grid

GetConnectivity() → AllElements

GetDimensions() → np.ndarray

ReadAttributes(attrs)