Skip to main content
Back to top
Ctrl
+
K
Installation
Module Reference
Examples
Issue Tracker
Get Help
GitHub
Installation
Module Reference
Examples
Issue Tracker
Get Help
GitHub
Section Navigation
utils
check_data_health
check_network_health
dict_to_struct
flat_list
get_mixture_model_args
get_printable_labels
get_printable_props
ignore_warnings
is_symmetric
is_transient
is_valid_propname
methods_to_table
models_to_table
sanitize_dict
struct_to_dict
Docorator
dedent
dedents
delete_kwargs
delete_kwargs_s
delete_params
delete_params_s
delete_types
delete_types_s
get_docstring
get_extended_summary
get_extended_summaryf
get_full_description
get_full_descriptionf
get_sections
get_sectionsf
get_summary
get_summaryf
keep_params
keep_params_s
keep_types
keep_types_s
save_docstring
with_indent
with_indents
HealthDict
NestedDict
PrintableDict
PrintableList
Project
SettingsAttr
TypedList
TypedMixin
TypedSet
add
difference
difference_update
discard
intersection
intersection_update
isdisjoint
issubset
issuperset
symmetric_difference
symmetric_difference_update
union
Workspace
close_project
copy_project
load_project
load_workspace
new_project
save_project
save_workspace
core
Base2
get_conduit_data
interpolate_data
props
to_indices
to_mask
Domain
add_model
add_model_collection
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
LabelMixin
filter_by_label
labels
num_pores
num_throats
pores
set_label
throats
ModelWrapper
ModelsDict
dependency_graph
dependency_list
dependency_map
ModelsMixin2
add_model
add_model_collection
regenerate_models
run_model
ParserMixin
network
BodyCenteredCubic
add_boundary_pores
add_model
add_model_collection
create_adjacency_matrix
create_incidence_matrix
filter_by_label
find_connected_pores
find_connecting_throat
find_nearby_pores
find_neighbor_pores
find_neighbor_throats
get_adjacency_matrix
get_conduit_data
get_incidence_matrix
interpolate_data
labels
num_neighbors
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
Cubic
add_boundary_pores
add_model
add_model_collection
create_adjacency_matrix
create_incidence_matrix
filter_by_label
find_connected_pores
find_connecting_throat
find_nearby_pores
find_neighbor_pores
find_neighbor_throats
get_adjacency_matrix
get_conduit_data
get_incidence_matrix
interpolate_data
labels
num_neighbors
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
CubicTemplate
add_model
add_model_collection
create_adjacency_matrix
create_incidence_matrix
filter_by_label
find_connected_pores
find_connecting_throat
find_nearby_pores
find_neighbor_pores
find_neighbor_throats
get_adjacency_matrix
get_conduit_data
get_incidence_matrix
interpolate_data
labels
num_neighbors
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
Delaunay
add_model
add_model_collection
create_adjacency_matrix
create_incidence_matrix
filter_by_label
find_connected_pores
find_connecting_throat
find_nearby_pores
find_neighbor_pores
find_neighbor_throats
get_adjacency_matrix
get_conduit_data
get_incidence_matrix
interpolate_data
labels
num_neighbors
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
DelaunayVoronoiDual
add_model
add_model_collection
create_adjacency_matrix
create_incidence_matrix
filter_by_label
find_connected_pores
find_connecting_throat
find_nearby_pores
find_neighbor_pores
find_neighbor_throats
find_pore_hulls
find_throat_facets
get_adjacency_matrix
get_conduit_data
get_incidence_matrix
interpolate_data
labels
num_neighbors
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
Demo
add_boundary_pores
add_model
add_model_collection
create_adjacency_matrix
create_incidence_matrix
filter_by_label
find_connected_pores
find_connecting_throat
find_nearby_pores
find_neighbor_pores
find_neighbor_throats
get_adjacency_matrix
get_conduit_data
get_incidence_matrix
interpolate_data
labels
num_neighbors
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
FaceCenteredCubic
add_boundary_pores
add_model
add_model_collection
create_adjacency_matrix
create_incidence_matrix
filter_by_label
find_connected_pores
find_connecting_throat
find_nearby_pores
find_neighbor_pores
find_neighbor_throats
get_adjacency_matrix
get_conduit_data
get_incidence_matrix
interpolate_data
labels
num_neighbors
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
Network
add_model
add_model_collection
create_adjacency_matrix
create_incidence_matrix
filter_by_label
find_connected_pores
find_connecting_throat
find_nearby_pores
find_neighbor_pores
find_neighbor_throats
get_adjacency_matrix
get_conduit_data
get_incidence_matrix
interpolate_data
labels
num_neighbors
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
Voronoi
add_model
add_model_collection
create_adjacency_matrix
create_incidence_matrix
filter_by_label
find_connected_pores
find_connecting_throat
find_nearby_pores
find_neighbor_pores
find_neighbor_throats
get_adjacency_matrix
get_conduit_data
get_incidence_matrix
interpolate_data
labels
num_neighbors
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
phase
Air
add_model
add_model_collection
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
BinaryGas
add_comp
add_model
add_model_collection
check_mixture_health
filter_by_label
get_comp_vals
get_conduit_data
get_mix_vals
interpolate_data
labels
num_pores
num_throats
pores
props
regenerate_models
remove_comp
run_model
set_label
throats
to_indices
to_mask
y
GasMixture
add_comp
add_model
add_model_collection
check_mixture_health
filter_by_label
get_comp_vals
get_conduit_data
get_mix_vals
interpolate_data
labels
num_pores
num_throats
pores
props
regenerate_models
remove_comp
run_model
set_label
throats
to_indices
to_mask
y
LiquidMixture
add_comp
add_model
add_model_collection
check_mixture_health
filter_by_label
get_comp_vals
get_conduit_data
get_mix_vals
interpolate_data
labels
num_pores
num_throats
pores
props
regenerate_models
remove_comp
run_model
set_label
throats
to_indices
to_mask
x
Mercury
add_model
add_model_collection
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
Mixture
add_comp
add_model
add_model_collection
check_mixture_health
filter_by_label
get_comp_vals
get_conduit_data
get_mix_vals
interpolate_data
labels
num_pores
num_throats
pores
props
regenerate_models
remove_comp
run_model
set_label
throats
to_indices
to_mask
Phase
add_model
add_model_collection
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
Species
add_model
add_model_collection
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
StandardGas
add_model
add_model_collection
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
StandardGasMixture
add_comp
add_model
add_model_collection
check_mixture_health
filter_by_label
get_comp_vals
get_conduit_data
get_mix_vals
interpolate_data
labels
num_pores
num_throats
pores
props
regenerate_models
remove_comp
run_model
set_label
throats
to_indices
to_mask
y
StandardLiquid
add_model
add_model_collection
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
StandardLiquidMixture
add_comp
add_model
add_model_collection
check_mixture_health
filter_by_label
get_comp_vals
get_conduit_data
get_mix_vals
interpolate_data
labels
num_pores
num_throats
pores
props
regenerate_models
remove_comp
run_model
set_label
throats
to_indices
to_mask
x
Water
add_model
add_model_collection
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
regenerate_models
run_model
set_label
throats
to_indices
to_mask
models
collections
geometry
circles_and_rectangles
cones_and_cylinders
cubes_and_cuboids
pyramids_and_cuboids
spheres_and_cylinders
squares_and_rectangles
trapezoids_and_rectangles
network
phase
air
gas
liquid
mercury
water
physics
basic
standard
geometry
conduit_lengths
circles_and_rectangles
cones_and_cylinders
cubes_and_cuboids
hybrid_cones_and_cylinders
hybrid_pyramids_and_cuboids
hybrid_trapezoids_and_rectangles
intersecting_cones
intersecting_pyramids
intersecting_trapezoids
pyramids_and_cuboids
spheres_and_cylinders
squares_and_rectangles
trapezoids_and_rectangles
diffusive_size_factors
circles_and_rectangles
cones_and_cylinders
cubes_and_cuboids
hybrid_cones_and_cylinders
hybrid_pyramids_and_cuboids
hybrid_trapezoids_and_rectangles
intersecting_cones
intersecting_pyramids
intersecting_trapezoids
ncylinders_in_series
pyramids_and_cuboids
spheres_and_cylinders
squares_and_rectangles
trapezoids_and_rectangles
hydraulic_size_factors
circles_and_rectangles
cones_and_cylinders
cubes_and_cuboids
hybrid_cones_and_cylinders
hybrid_pyramids_and_cuboids
hybrid_trapezoids_and_rectangles
intersecting_cones
intersecting_pyramids
intersecting_trapezoids
ncylinders_in_series
pyramids_and_cuboids
spheres_and_cylinders
squares_and_rectangles
trapezoids_and_rectangles
pore_cross_sectional_area
circle
cone
cube
sphere
square
pore_seed
random
spatially_correlated
pore_size
equivalent_diameter
from_neighbor_throats
generic_distribution
largest_sphere
normal
random
weibull
pore_surface_area
circle
cube
sphere
square
pore_volume
circle
cube
effective
sphere
square
throat_capillary_shape_factor
jenkins_rao
mason_morrow
throat_centroid
pore_coords
throat_cross_sectional_area
cuboid
cylinder
rectangle
throat_endpoints
spheres_and_cylinders
throat_length
circles_and_rectangles
cones_and_cylinders
cubes_and_cuboids
hybrid_cones_and_cylinders
hybrid_pyramids_and_cuboids
hybrid_trapezoids_and_rectangles
intersecting_cones
intersecting_pyramids
intersecting_trapezoids
pyramids_and_cuboids
spheres_and_cylinders
squares_and_rectangles
trapezoids_and_rectangles
throat_perimeter
cuboid
cylinder
rectangle
throat_seed
from_neighbor_pores
random
throat_size
equivalent_diameter
from_neighbor_pores
generic_distribution
normal
random
weibull
throat_surface_area
cuboid
cylinder
extrusion
rectangle
throat_vector
pore_to_pore
throat_volume
cuboid
cylinder
extrusion
lens
pendular_ring
rectangle
misc
blank
clip
constant
difference
fraction
from_neighbor_pores
from_neighbor_throats
generic_distribution
generic_function
invert
linear
match_histogram
normal
normalize
polynomial
product
random
scaled
summation
weibull
network
bidirectional_throats
cluster_number
cluster_size
coordination_number
count_coincident_pores
distance_to_furthest_neighbor
distance_to_nearest_neighbor
distance_to_nearest_pore
duplicate_throats
find_coincident_pores
gabriel_edges
headless_throats
isolated_pores
looped_throats
pore_to_pore_distance
reversed_throats
phase
chemicals_wrapper
critical_props
density
ideal_gas
liquid_mixture_COSTALD
liquid_pure_COSTALD
mass_to_molar
water_correlation
diffusivity
gas_mixture_ce
gas_mixture_fesg
liquid_mixture_tc
heat_capacity
gas_mixture_yweighted
gas_pure_TRC
liquid_mixture_xweighted
liquid_pure_rp
misc
mix_and_match
mole_to_mass_fraction
mixtures
from_component
mixing_rule
mole_summation
mole_to_mass_fraction
salinity
partition_coefficient
gaseous_species_in_water
surface_tension
liquid_mixture_wsd
liquid_pure_bb
water_correlation
thermal_conductivity
gas_mixture_whz
gas_pure_gismr
liquid_mixture_DIPPR9H
liquid_pure_gismr
liquid_pure_sr
water_correlation
vapor_pressure
liquid_pure_antoine
liquid_pure_lk
water_correlation
viscosity
gas_mixture_hz
gas_pure_gesmr
gas_pure_st
liquid_mixture_xweighted
liquid_pure_ls
water_correlation
physics
ad_dif_conductance
ad_dif
capillary_pressure
purcell
washburn
diffusive_conductance
generic_diffusive
mixed_diffusion
ordinary_diffusion
taylor_aris_diffusion
electrical_conductance
generic_electrical
series_resistors
hydraulic_conductance
generic_hydraulic
hagen_poiseuille
valvatne_blunt
meniscus
general_toroidal
purcell
sinusoidal
multiphase
conduit_conductance
late_filling
source_terms
butler_volmer_conc
butler_volmer_voltage
exponential
general_symbolic
linear
logarithm
natural_exponential
natural_logarithm
power_law
standard_kinetics
thermal_conductance
generic_thermal
series_resistors
solvers
BaseSolver
solve
DirectSolver
solve
IterativeSolver
solve
PETScLinearSolver
solve
PardisoSpsolve
solve
PyamgRugeStubenSolver
solve
ScipyCG
solve
ScipySpsolve
solve
integrators
Integrator
ScipyRK45
solve
algorithms
AdvectionDiffusion
clear_BCs
clear_rate_BCs
clear_value_BCs
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
rate
run
set_BC
set_label
set_outflow_BC
set_rate_BC
set_source
set_value_BC
throats
to_indices
to_mask
Algorithm
clear_BCs
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
set_BC
set_label
throats
to_indices
to_mask
Drainage
apply_trapping
clear_BCs
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
reset
run
set_BC
set_inlet_BC
set_label
set_outlet_BC
throats
to_indices
to_mask
FickianDiffusion
clear_BCs
clear_rate_BCs
clear_value_BCs
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
rate
run
set_BC
set_label
set_rate_BC
set_source
set_value_BC
throats
to_indices
to_mask
FourierConduction
clear_BCs
clear_rate_BCs
clear_value_BCs
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
rate
run
set_BC
set_label
set_rate_BC
set_source
set_value_BC
throats
to_indices
to_mask
InvasionPercolation
apply_trapping
clear_BCs
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pc_curve
pores
props
run
set_BC
set_inlet_BC
set_label
set_outlet_BC
throats
to_indices
to_mask
OhmicConduction
clear_BCs
clear_rate_BCs
clear_value_BCs
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
rate
run
set_BC
set_label
set_rate_BC
set_source
set_value_BC
throats
to_indices
to_mask
ReactiveTransport
clear_BCs
clear_rate_BCs
clear_value_BCs
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
rate
run
set_BC
set_label
set_rate_BC
set_source
set_value_BC
throats
to_indices
to_mask
StokesFlow
clear_BCs
clear_rate_BCs
clear_value_BCs
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
rate
run
set_BC
set_label
set_rate_BC
set_source
set_value_BC
throats
to_indices
to_mask
TransientAdvectionDiffusion
clear_BCs
clear_rate_BCs
clear_value_BCs
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
rate
run
set_BC
set_label
set_outflow_BC
set_rate_BC
set_source
set_value_BC
throats
to_indices
to_mask
TransientFickianDiffusion
clear_BCs
clear_rate_BCs
clear_value_BCs
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
rate
run
set_BC
set_label
set_rate_BC
set_source
set_value_BC
throats
to_indices
to_mask
TransientFourierConduction
clear_BCs
clear_rate_BCs
clear_value_BCs
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
rate
run
set_BC
set_label
set_rate_BC
set_source
set_value_BC
throats
to_indices
to_mask
TransientReactiveTransport
clear_BCs
clear_rate_BCs
clear_value_BCs
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
rate
run
set_BC
set_label
set_rate_BC
set_source
set_value_BC
throats
to_indices
to_mask
Transport
clear_BCs
clear_rate_BCs
clear_value_BCs
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
rate
run
set_BC
set_label
set_rate_BC
set_value_BC
throats
to_indices
to_mask
topotools
add_boundary_pores
add_reservoir_pore
bond_percolation
clone_pores
connect_pores
conns_to_am
dimensionality
drop_sites
extend
filter_pores_by_z
find_clusters
find_connected_sites
find_connecting_bonds
find_interface_throats
find_isolated_clusters
find_neighbor_bonds
find_neighbor_sites
find_path
find_surface_pores
generate_base_points
get_domain_area
get_domain_length
get_shape
get_spacing
hull_centroid
is_fully_connected
iscoplanar
isoutside
ispercolating
issymmetric
istriangular
istril
istriu
label_faces
merge_networks
merge_pores
reduce_coordination
reflect_base_points
rotate_coords
shear_coords
site_percolation
stitch
template_cylinder_annulus
template_sphere_shell
tri_to_am
trim
trim_disconnected_clusters
vor_to_am
io
network_from_csv
network_from_jsongraph
network_from_marock
network_from_networkx
network_from_pergeos
network_from_porespy
network_from_statoil
network_to_comsol
network_to_csv
network_to_jsongraph
network_to_networkx
network_to_pandas
network_to_pergeos
network_to_salome
network_to_stl
print_hdf5
project_to_csv
project_to_dict
project_to_hdf5
project_to_pandas
project_to_paraview
project_to_vtk
project_to_xdmf
contrib
multiphase_diffusion
MultiPhase
add_model
add_model_collection
add_phases
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
regenerate_models
run_model
set_binary_partition_coef
set_label
set_occupancy
throats
to_indices
to_mask
TransientMultiPhysics
clear_BCs
filter_by_label
get_conduit_data
interpolate_data
labels
num_pores
num_throats
pores
props
run
set_BC
set_label
throats
to_indices
to_mask
visualization
draw_conduit
generate_voxel_image
plot_connections
plot_coordinates
plot_networkx
plot_notebook
plot_tutorial
plot_vispy
set_mpl_style
Module Reference
phase
critical_props
This is a module
critical_props
#
