Muscat.IO.XdmfWriter module

Xdmf file writer

ArrayToString(data)

class BinaryStorage(data=None, filePointer=None)

Bases: object

Class to deal with binary storage

ChangePathOfBinaryStorage(newPath)

GetData()

UpdateHeavyStorage(data)

CheckIntegrity(GUI: bool = False)

CheckIntegrityDDM(GUI: bool = False)

this test function can be launched using the mpirun -n 2 … to test the writer in mpi mode

CheckIntegrityHdf5(tempdir)

class Hdf5Storage(data, filename, datasetName)

Bases: object

Class to deal with hdf5 storage

GetData()

UpdateHeavyStorage(data)

class InMemoryFile(saveFilePointer)

Bases: object

Helper class to write the xmf part of the file into memory

close()

flush()

seek(pos)

tell()

write(data)

WriteMeshToXdmf(filename, baseMeshObject, PointFields=None, CellFields=None, GridFields=None, IntegrationPointData=None, PointFieldsNames=None, CellFieldsNames=None, GridFieldsNames=None, IntegrationPointDataNames=None, IntegrationRule=None, Binary=True, HDF5=True)

Function API for writing mesh in the xdmf format file.

Parameters:

• fileName (str) – name of the file to be written

• baseMeshObject (Mesh) – the mesh to be written

• PointFields (list[np.ndarray], optional) – fields to write defined at the vertices of the mesh, by default None

• CellFields (list[np.ndarray], optional) – fields to write defined at the elements of the mesh, by default None

• GridFields (list[np.ndarray], optional) – grid fields to write, by default None

• IntegrationPointData (list[np.ndarray], optional) – fields defined at the integration points, by default None

• PointFieldsNames (list[str], optional) – names of the fields to write defined at the vertices of the mesh, by default None

• CellFieldsNames (list[str], optional) – names of the fields to write defined at the elements of the mesh, by default None

• GridFieldsNames (list[str], optional) – names of the grid fields to write, by default None

• IntegrationPointDataNames (list[str], optional) – names of the fields defined at the integration points, by default None

• IntegrationRule (dict[IntegrationRuleType], optional) – integration rules associated to the integration point data, by default None

• Binary (bool, optional) – if True, file is written as binary, by default True

• HDF5 (bool, optional) – if True, file is written as hdf5 format, by default True

WriteTest(tempdir, Temporal, Binary, Hdf5)

WriteTestAppend(tempdir, Temporal, Binary)

class XdmfWriter(fileName=None)

Bases: WriterBase

Class to Write Xdmf files for:

• classic finite element solutions

• domain decomposition problem (multi mesh)

• transient solution (the mesh changes in time)

• solution written in parafac format (monolithic or in ddm mpi)

Close()

Closes writen file after writing operations are done

GetHdf5()

IsHdf5()

IsParafacOutput()

MakeStep(Time=None, TimeStep=None)

Increases time step in output files

Parameters:

• Time (float, optional) – time value of the time step, by default None

• TimeStep (int, optional) – number of the time step, by default None

NewBinaryFilename()

NewHdf5Filename()

NextDomain()

Open(filename=None)

Open file for writing

Parameters:

filename (str, optional) – name of the file to write

SetBinary(val=True)

Sets the binary status of the file to read

Parameters:

val (bool, optional) – if True, sets the file to read as binary, by default True

SetChunkSize(size)

SetFileName(fileName)

Sets the fileName parameter of the class

Parameters:

string (str) – fileName to set

SetHdf5(val=True)

SetParafac(val=True)

SetXmlSizeLimit(val)

Step(dt=1)

Write(mesh, PointFields=None, CellFields=None, GridFields=None, PointFieldsNames=None, CellFieldsNames=None, GridFieldsNames=None, Time=None, TimeStep=None, domainName=None, IntegrationRule=None, IntegrationPointData=None, IntegrationPointDataNames=None)

Write data to file in xdmf format

Parameters:

• mesh (Mesh) – the mesh to be written

• PointFields (list[np.ndarray], optional) – fields to write defined at the vertices of the mesh, by default None

• CellFields (list[np.ndarray], optional) – fields to write defined at the elements of the mesh, by default None

• GridFields (list[np.ndarray], optional) – grid fields to write, by default None

• PointFieldsNames (list[str], optional) – names of the fields to write defined at the vertices of the mesh, by default None

• CellFieldsNames (list[str], optional) – names of the fields to write defined at the elements of the mesh, by default None

• GridFieldsNames (list[str], optional) – names of the grid fields to write, by default None

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

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

• domainName (str, optional) – Not Used, by default None

• IntegrationRule (dict[IntegrationRuleType], optional) – integration rules associated to the integration point data, by default None

• IntegrationPointData (list[np.ndarray], optional) – fields defined at the integration points, by default None

• IntegrationPointDataNames (list[str], optional) – names of the fields defined at the integration points, by default None

WriteIntegrationsPointData(names, allData)

Writes integration points data to file

WriteIntegrationsPoints(quadrature: MeshQuadrature, mesh: Mesh)

Writes integration points information to file, this will write only for elements present on the mesh

WriteTail()

Writes the end of the file

isBinary()