API Reference#
The reference guide contains a detailed description of the functions, modules, and objects included in the library. The reference describes how the methods work and which parameters can be used. It assumes that you have an understanding of the key concepts.
- Abstract data types and protocols
- Data structures
CellDataLineDataPointDataPolyCellPolyCell.area()PolyCell.areas()PolyCell.boundary()PolyCell.centers()PolyCell.containerPolyCell.coords()PolyCell.dbPolyCell.detach_points_cells()PolyCell.extract_surface()PolyCell.flip()PolyCell.framesPolyCell.from_parquet()PolyCell.glob_to_loc()PolyCell.jacobian()PolyCell.jacobian_matrix()PolyCell.length()PolyCell.lengths()PolyCell.loc_to_glob()PolyCell.local_coordinates()PolyCell.locate()PolyCell.measure()PolyCell.measures()PolyCell.normals()PolyCell.pdPolyCell.pip()PolyCell.pointdataPolyCell.points_involved()PolyCell.points_of_cells()PolyCell.pull()PolyCell.rewire()PolyCell.root()PolyCell.source()PolyCell.source_coords()PolyCell.source_frame()PolyCell.source_points()PolyCell.thickness()PolyCell.to_parquet()PolyCell.to_pv()PolyCell.to_simplices()PolyCell.to_tetrahedra()PolyCell.to_triangles()PolyCell.to_vtk()PolyCell.topology()PolyCell.unique_indices()PolyCell.volume()PolyCell.volumes()
PolyDataPolyData.area()PolyData.areas()PolyData.blocks()PolyData.blocks_of_cells()PolyData.bounds()PolyData.cdPolyData.cell_fieldsPolyData.cell_indices()PolyData.cellblocks()PolyData.celldataPolyData.cells_around_cells()PolyData.cells_at_nodes()PolyData.cells_coords()PolyData.center()PolyData.centers()PolyData.centralize()PolyData.configPolyData.coords()PolyData.copy()PolyData.deepcopy()PolyData.detach()PolyData.framePolyData.from_meshio()PolyData.from_pv()PolyData.index_of_closest_cell()PolyData.index_of_closest_point()PolyData.index_of_furthest_cell()PolyData.index_of_furthest_point()PolyData.is_2d_mesh()PolyData.is_source()PolyData.k3dplot()PolyData.k_nearest_cell_neighbours()PolyData.lock()PolyData.move()PolyData.nodal_adjacency()PolyData.nodal_adjacency_matrix()PolyData.nodal_distribution_factors()PolyData.nodal_neighbourhood_matrix()PolyData.number_of_cells()PolyData.number_of_points()PolyData.nummrg()PolyData.parentPolyData.pdPolyData.plot()PolyData.point_fieldsPolyData.pointblocks()PolyData.pointdataPolyData.points()PolyData.pvPolyData.pvplot()PolyData.read()PolyData.rewire()PolyData.rotate()PolyData.source()PolyData.spin()PolyData.surface()PolyData.surface_centers()PolyData.surface_normals()PolyData.to_ak()PolyData.to_dataframe()PolyData.to_k3d()PolyData.to_lists()PolyData.to_parquet()PolyData.to_pv()PolyData.to_standard_form()PolyData.to_vtk()PolyData.topology()PolyData.unlock()PolyData.volume()PolyData.volumes()PolyData.vtk
TriMesh
- Space
CartesianFramePointPointCloudPointCloud.bounds()PointCloud.center()PointCloud.centralize()PointCloud.closest()PointCloud.framePointCloud.furthest()PointCloud.idPointCloud.idsort()PointCloud.index_of_closest()PointCloud.index_of_furthest()PointCloud.move()PointCloud.rotate()PointCloud.show()PointCloud.sort_indices()PointCloud.x()PointCloud.y()PointCloud.z()
StandardFrame
- TopologyArray
- Cell classes
- Cell approximator
- Mesh generation
- Recipes
- Downloadable examples
- Plotting
- Utilities
frame_of_plane()frames_of_lines()frames_of_surfaces()index_of_closest_point()index_of_furthest_point()is_line()is_planar()is_planar_surface()tr_cell_glob_to_loc_bulk()cells_at_nodes()count_cells_at_nodes()detach()detach_mesh_bulk()detach_mesh_data_bulk()is_regular()nodal_adjacency()regularize()remap_topo()rewire()unique_topo_data()transform_topology()area_tri()area_tri_bulk()areas_tri()center_tri_2d()center_tri_3d()center_tri_bulk_3d()glob_to_loc_tri()glob_to_nat_tri()inscribed_radii()inscribed_radius()lcoords_tri()loc_to_glob_tri()loc_to_nat_tri()nat_to_glob_tri()nat_to_loc_tri()ncenter_tri()shp_tri_loc()TET4_edge_vectors()TET4_face_normals()glob_to_nat_tet()lcoords_tet()nat_to_loc_tet()pip_tet()pip_tet_bulk()vol_tet()vol_tet_bulk()k_nearest_neighbours()cell_center()cell_center_2d()cell_centers_bulk()cell_centers_bulk2()cell_coords()cells_around()cells_coords()center_of_points()centralize()collect_nodal_data()decompose()distances_of_points()distribute_nodal_data_bulk()distribute_nodal_data_sparse()explode_mesh_bulk()explode_mesh_data_bulk()global_shape_function_derivatives()homogenize_nodal_values()is_ccw()is_cw()jacobian_det_bulk_1d()jacobian_matrix_bulk()jacobian_matrix_bulk_1d()jacobian_matrix_single()lengths_of_lines()lengths_of_lines2()nodal_distribution_factors()norms()pcoords_to_coords_1d()points_around()points_of_cells()