mammos_mumag.mesh#

Mesh functions.

Functions

find_mesh([mesh_name])

Find available meshes matching given name.

get_mesh_json()

Load mesh JSON file.

Classes

Mesh(mesh_name)

Mesh class.
class mammos_mumag.mesh.Mesh(mesh_name)[source]#

Mesh class.

Initialize Mesh with either mesh_name or path for local meshes.

Parameters:

mesh_name (str | Path)

write(dest)[source]#

Write mesh to destination.

Parameters:

dest (Path | str)

Return type:

None

mammos_mumag.mesh.find_mesh(mesh_name=None)[source]#

Find available meshes matching given name.

Parameters:

mesh_name (str | None) – Desired mesh name. If None, returns all available meshes.

Returns:

List of matches with given name. Empty list if no matches are found.

Return type:

list[str]

mammos_mumag.mesh.get_mesh_json()[source]#

Load mesh JSON file.