Skip to content

cycletools

extract_boundary_cycles(phasefield)

Extract boundary cycles from mesh boundaries.

Parameters:

Name Type Description Default
phasefield PhaseField

Phasefield mesh containing vertices, faces, edges, and face_masks.

required

Returns:

Type Description
DataFrame

pd.DataFrame: DataFrame representing cycles with columns: 'time_axis', 'nodes', 'top_charge', 'wave_number', 'n_nodes'.

extract_face_cycles(phasefield)

Extract mesh face cycles.

Parameters:

Name Type Description Default
phasefield PhaseField

Phasefield mesh containing faces, phase differences for each face, and face_masks.

required

Returns:

Type Description
DataFrame

pd.DataFrame: DataFrame representing cycles with columns: 'time_axis', 'nodes', 'top_charge', 'wave_number', 'n_nodes'.