pymm.core.pymm module

Main script

pymm.core.pymm.boundary_tags_left_bottom(dic)

Function to identify the wall, left, and bottom boundary tags

Args:

dic (dict): Global dictionary with required parameters

Returns:

dic (dict): Global dictionary with new added parameters

pymm.core.pymm.boundary_tags_right_top(dic)

Function to identify the wall, right, and top boundary tags

Args:

dic (dict): Global dictionary with required parameters

Returns:

dic (dict): Global dictionary with new added parameters

pymm.core.pymm.extract_borders(dic)

Function to extract the borders of the image

Args:

dic (dict): Global dictionary with required parameters

Returns:

dic (dict): Global dictionary with new added parameters

pymm.core.pymm.identify_cells(dic)

Function to extract the cell locations on the borders

Args:

dic (dict): Global dictionary with required parameters

Returns:

dic (dict): Global dictionary with new added parameters

pymm.core.pymm.main()

Main function

pymm.core.pymm.make_figures(dic)

Function to make figures with the extract grains and contours

Args:

dic (dict): Global dictionary with required parameters

Returns:

dic (dict): Global dictionary with new added parameters

pymm.core.pymm.pad_with(vector, pad_width, _iaxis, kwargs)

Function to add extra border to later extract the image boundaries see https://numpy.org/doc/stable/reference/generated/numpy.pad.html

pymm.core.pymm.process_image(dic, in_image)

Function to process the input image

Args:

dic (dict): Global dictionary with required parameters in_image (str): Name of the input image data

Returns:

dic (dict): Global dictionary with new added parameters

pymm.core.pymm.process_input(dic, in_file)

Function to process the input file

Args:

dic (dict): Global dictionary with required parameters in_file (str): Name of the input text file

Returns:

dic (dict): Global dictionary with new added parameters

pymm.core.pymm.pymm()

Python for microsystems

pymm.core.pymm.run_stokes(dic)

Function to write the openFOAM files to run the Navier-Stokes flow simulations

Args:

dic (dict): Global dictionary with required parameters

Returns:

dic (dict): Global dictionary with new added parameters

pymm.core.pymm.run_tracer(dic)

Function to write the openFOAM files to run the Tracer flow simulations

Args:

dic (dict): Global dictionary with required parameters

pymm.core.pymm.write_geo(dic)

Function to write the Gmsh .geo file

Args:

dic (dict): Global dictionary with required parameters

Returns:

dic (dict): Global dictionary with new added parameters