API Reference
This reference contains a detailed explaination of all public and private packages, classes, and functions used in this library. You should always consults the examples and the source code for usage.
- Main Functions
- ABC for Auxetic Unit Cells
- ABC for Auxetic Structures
AuxeticStructure
AuxeticStructure.__init__()
AuxeticStructure.assemble_structure()
AuxeticStructure.add_pattern_params()
AuxeticStructure.add_unit_cells()
AuxeticStructure.get_unit_cell_by_id()
AuxeticStructure.assign_material()
AuxeticStructure.define_step()
AuxeticStructure.define_bcs()
AuxeticStructure.mesh_part()
AuxeticStructure.create_job()
AuxeticStructure.submit_job()
AuxeticStructure.output_results()
- Unit Cell Parameters
Reentrant2DUcpFull
Reentrant2DUcpFull.diag_strut_angle
Reentrant2DUcpFull.diag_strut_length
Reentrant2DUcpFull.diag_strut_thickness
Reentrant2DUcpFull.extrusion_depth
Reentrant2DUcpFull.formal_names
Reentrant2DUcpFull.id
Reentrant2DUcpFull.tail_strut_length
Reentrant2DUcpFull.tail_strut_thickness
Reentrant2DUcpFull.unit_cell_type
Reentrant2DUcpFull.vert_strut_length
Reentrant2DUcpFull.vert_strut_thickness
Reentrant2DUcpBox
Reentrant2DUcpBox.diag_strut_angle
Reentrant2DUcpBox.diag_strut_thickness
Reentrant2DUcpBox.extrusion_depth
Reentrant2DUcpBox.formal_names
Reentrant2DUcpBox.horz_bounding_box
Reentrant2DUcpBox.id
Reentrant2DUcpBox.unit_cell_type
Reentrant2DUcpBox.vert_bounding_box
Reentrant2DUcpBox.vert_strut_thickness
Reentrant2DUcpSimple
- Auxetic Structure Parameters
- Classes Based on Different Unit Cells
- Reentrant-2D Unit Cell
Reentrant2DUnitCell
Reentrant2DPlanarShellStructure
Reentrant2DPlanarShellStructure.pretty_name
Reentrant2DPlanarShellStructure.is_solid
Reentrant2DPlanarShellStructure.is_shell
Reentrant2DPlanarShellStructure.is_bulk
Reentrant2DPlanarShellStructure.is_planar
Reentrant2DPlanarShellStructure.is_tubular
Reentrant2DPlanarShellStructure.unit_cell_class
Reentrant2DPlanarShellStructure.assemble_core_structure()
Reentrant2DPlanarShellStructure.assemble_structure()
create_sketch_reentrant2d_full()
create_sketch_reentrant2d_box()
create_sketch_reentrant2d_simple()
- Reentrant-2D Unit Cell
- Helper Functions
create_ribbon_part()
draw_line()
find_edges_from_coords()
find_vertices_from_coords()
find_vertices_from_coords_minmax()
find_regular_geometries()
get_part_box_size()
get_box_coords()
return_results_folder_path()
return_sketch_name()
return_unit_cell_name_main()
return_unit_cell_name_3dprint()
return_instance_name()
transfer_instance_to_zero()