python_scripts.utilities.GenerateHDF5Journal Namespace Reference

Classes
class	HDF5Path
	Filesystem path to an HDF5 file and a prefix within, uniquely identifying dataset/group. More...
class	GenerateHDF5Journal
	Generate a Kratos::Journal from globbed HDF5 results. More...

Functions
"dict[str,list[str]]"	MapUnion ("dict[str,list[str]]" left, "dict[str,list[str]]" right)
	Try combing the two placeholder maps. More...
typing.Union[int, float]	ExtractTimeLabel ("dict[str,list[str]]" placeholders, typing.Union[int, float] fallback)
"list[str]"	GlobHDF5 (WRApp.ModelPartPattern pattern, h5py.File file, verbose=False)
None	MakeJournal (str input_file_pattern, str results_prefix, str mesh_prefix, str output_path, bool verbose=False)
	Create a Kratos::Journal from globbed paths. More...
typing.Union[int, float, str]	InputFileOrdering ("tuple[str,dict[str,list[str]],bool]" item)
	Takes a file name and its output from ModelPartPattern, and extract data on which it should be ordered. More...

Detailed Description

Author

Máté Kelemen

Function Documentation

ExtractTimeLabel()

typing.Union[int,float] python_scripts.utilities.GenerateHDF5Journal.ExtractTimeLabel	(	"dict[str,list[str]]"	placeholders,
		typing.Union[int,float]	fallback
	)

GlobHDF5()

"list[str]" python_scripts.utilities.GenerateHDF5Journal.GlobHDF5	(	WRApp.ModelPartPattern	pattern,
		h5py.File	file,
			verbose = False
	)

InputFileOrdering()

typing.Union[int,float,str] python_scripts.utilities.GenerateHDF5Journal.InputFileOrdering

(

"tuple[str,dict[str,list[str]],bool]"

item

)

Takes a file name and its output from ModelPartPattern, and extract data on which it should be ordered.

Ordering happens on the first available variable in the following list:

• step index, if present in the match results
• time, if present in the match results
• 0

MakeJournal()

None python_scripts.utilities.GenerateHDF5Journal.MakeJournal	(	str	input_file_pattern,
		str	results_prefix,
		str	mesh_prefix,
		str	output_path,
		bool	verbose = False
	)

Create a Kratos::Journal from globbed paths.

MapUnion()

"dict[str,list[str]]" python_scripts.utilities.GenerateHDF5Journal.MapUnion	(	"dict[str,list[str]]"	left,
		"dict[str,list[str]]"	right
	)

Try combing the two placeholder maps.

If the two maps have identical keys, their values must match.