field

read_geom

read_geom(xdmf: FieldXmf, snapshot: int) -> dict[str, Any]

Extract geometry information from hdf5 files.

Parameters:

Name	Type	Description	Default
xdmf	FieldXmf	xdmf file parser.	required
snapshot	int	snapshot number.	required

Returns:

Type	Description
dict[str, Any]	geometry information.

field

field(
    xdmf: FieldXmf,
    fieldname: str,
    snapshot: int,
    header: dict[str, Any] | None = None,
) -> tuple[dict[str, Any], NDArray[np.float64]] | None

Extract field data from hdf5 files.

Parameters:

Name	Type	Description	Default
xdmf	FieldXmf	xdmf file parser.	required
fieldname	str	name of field to extract.	required
snapshot	int	snapshot number.	required
header	dict[str, Any] | None	geometry information.	None

Returns:

Type	Description
tuple[dict[str, Any], NDArray[float64]] | None	geometry information and field data. None is returned if data is unavailable.