mesh_comparator

MeshComparator

compare_cellbox_attributes(mesh1, mesh2, return_type=None)

Compare the attributes of the cellboxes in the two meshes if the meshes have cellboxes in common

Parameters:

Name	Type	Description	Default
mesh1	json	the first mesh to compare	required
mesh2	json	the second mesh to compare	required
return_type	str	Type of output user wants. Defaults to pd.DataFrame.	None

Returns:

Type	Description
	: Output in format specified by return_type argument. See _return_as() docstring for more info

compare_cellbox_boundaries(mesh1, mesh2, return_type=None)

Compare the boundaries of the cellboxes in the two meshes

Parameters:

Name	Type	Description	Default
mesh1	json	the first mesh to compare	required
mesh2	json	the second mesh to compare	required
return_type	str	Type of output user wants. Defaults to pd.DataFrame.	None

Returns:

Type	Description
	: Output in format specified by return_type argument. See _return_as() docstring for more info

compare_cellbox_values(mesh1, mesh2, return_type=None)

Compare the values of the cellboxes in the two meshes in cellboxes that both meshes have in common

Parameters:

Name	Type	Description	Default
mesh1	json	the first mesh to compare	required
mesh2	json	the second mesh to compare	required
return_type	str	Type of output user wants. Defaults to pd.DataFrame.	None

Returns:

Type	Description
	: Output in format specified by return_type argument. See _return_as() docstring for more info

compare_neighbour_graph_values(mesh1, mesh2, return_type=None)

Compare the values of the neighbour graph in the two meshes

Parameters:

Name	Type	Description	Default
mesh1	json	the first mesh to compare	required
mesh2	json	the second mesh to compare	required
return_type	str	Type of output user wants. Defaults to pd.DataFrame.	None

Returns:

Type	Description
	: Output in format specified by return_type argument. See _return_as() docstring for more info