Examples#
The best way to learn OpenPNM (like anything) is to experiment. In this page, you can find lots of examples that will help you get started. The examples are categorized into the following categories:
General#
Generators#
blobsbordersbundle_of_tubescylinderscylindrical_pillars_arraycylindrical_pillars_meshcylindrical_plugfacesfractal_noiseinsert_shapelattice_spheresline_segmentoverlapping_spherespolydisperse_spherespseudo_electrostatic_packingphipseudo_gravity_packingramprandom_cantor_dustrandom_spheresrectangular_pillars_arraysierpinski_foamspheres_from_coordsvoronoi_edges
Filters#
apply_chordsapply_chords_3Dapply_paddedchunked_funcdistance_transform_linfftmorphologyfill_closed_poresfind_disconnected_voxelsfind_dt_artifactsfind_peaksfind_trapped_clustersfloodflood_funchold_peakslocal_thicknessnl_means_layerednphase_borderpc_to_satnporosimetryprune_branchesreduce_peaksregion_sizesatn_to_seqseq_to_satnsize_to_satnsize_to_seqsnow_partitioningsnow_partitioning_nsnow_partitioning_paralleltrim_disconnected_voxelstrim_extrematrim_floating_solidtrim_nearby_peakstrim_nonpercolating_pathstrim_saddle_pointstrim_small_clusters
Metrics#
bond_numberboxcountchord_countschord_length_distributionfind_hfind_porosity_thresholdconnis_percolatinglineal_path_distributionmesh_volumemesh_surface_areapc_map_to_pc_curvepercolating_porosityphase_fractionpore_size_distributionporosityporosity_profileprops_to_DataFrameprops_to_imageradial_density_distributionregion_interface_areasregion_surface_areasregion_volumesregionprops_3Drev_porosityrev_tortuositysatn_profiletwo_point_correlation
Networks#
Simulations#
- Details of Drainage Simulations with and without Gravity
- Basics of Peforming Drainage Simulations with and without Gravity
- Finding the Tortuosity (\(\tau\)) of an Image Using tortuosity_fd
- Overview of Image-Based Two-Phase Flow Simulations - Part 1: Drainage
- Overview of Image-Based Two-Phase Flow Simulations - Part 2: Imbibition
- Overview of Image-Based Two-Phase Flow Simulations - Part 3: Injection
- Using the Injection Algorithm
rev_tortuosity
Tools#
align_image_with_openpnmall_to_uniformbbox_to_slicesextend_slice[WIP]extract_cylinderextract_regionsextract_subsectionget_planesget_slices_gridinsert_cylinderinsert_sphereisolate_object[WIP]make_contiguousmarching_map[WIP]mesh_region[WIP]overlayrandomize_colors[WIP]recombine[WIP]unpad