Installation
User Guide
Module Reference
Examples
Issue Tracker
Get Help
GitHub
Substack
Twitter
Utils
catch_module_not_found
flat_list
ignore_warnings
is_symmetric
is_valid_propname
methods_to_table
models_to_table
prettify_logger_message
remove_prop_deep
sanitize_dict
tic
toc
unique_list
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
move_to_end
NestedDict
PrintableDict
move_to_end
PrintableList
Project
check_data_health
check_geometry_health
check_network_health
check_physics_health
export_data
find_full_domain
find_geometry
find_phase
find_physics
inspect_locations
load_object
purge_object
save_object
save_project
show_model_dependencies
SettingsAttr
SubDict
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
Misc
catch_module_not_found
end_all
flat_list
ignore_warnings
is_symmetric
is_valid_propname
methods_to_table
models_to_table
prettify_logger_message
remove_prop_deep
sanitize_dict
start_all
tic
toc
unique_list
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
DocstringProcessor
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
move_to_end
NestedDict
OrderedDict
move_to_end
PrintableDict
move_to_end
PrintableList
SubDict
Core
Base
get_conduit_data
interleave_data
interpolate_data
props
show_hist
to_indices
to_mask
LabelMixin
filter_by_label
labels
num_pores
num_throats
pores
set_label
throats
LegacyMixin
map_pores
map_throats
toindices
tomask
ModelsDict
dependency_graph
dependency_list
dependency_map
move_to_end
ModelsMixin
add_model
regenerate_models
remove_model
ParamMixin
params
Subdomain
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
pores
props
set_label
set_locations
show_hist
throats
to_global
to_indices
to_local
to_mask
Network
Bravais
add_boundary_pores
add_model
check_network_health
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
interleave_data
interpolate_data
labels
num_neighbors
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
Cubic
add_boundary_pores
add_model
check_network_health
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
interleave_data
interpolate_data
labels
num_neighbors
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
CubicDual
add_boundary_pores
add_model
check_network_health
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
interleave_data
interpolate_data
labels
num_neighbors
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
CubicTemplate
add_boundary_pores
add_model
check_network_health
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
interleave_data
interpolate_data
labels
num_neighbors
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
Delaunay
add_boundary_pores
add_model
check_network_health
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
interleave_data
interpolate_data
labels
num_neighbors
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
DelaunayVoronoiDual
add_boundary_pores
add_model
check_network_health
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
interleave_data
interpolate_data
labels
num_neighbors
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
Gabriel
add_boundary_pores
add_model
check_network_health
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
interleave_data
interpolate_data
labels
num_neighbors
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
GenericNetwork
add_model
check_network_health
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
interleave_data
interpolate_data
labels
num_neighbors
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
Voronoi
add_boundary_pores
add_model
check_network_health
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
interleave_data
interpolate_data
labels
num_neighbors
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
Geometry
CirclesAndRectangles
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
set_locations
show_hist
throats
to_global
to_indices
to_local
to_mask
ConesAndCylinders
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
set_locations
show_hist
throats
to_global
to_indices
to_local
to_mask
CubesAndCuboids
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
set_locations
show_hist
throats
to_global
to_indices
to_local
to_mask
GenericGeometry
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
set_locations
show_hist
throats
to_global
to_indices
to_local
to_mask
Imported
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
set_locations
show_hist
throats
to_global
to_indices
to_local
to_mask
PyramidsAndCuboids
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
set_locations
show_hist
throats
to_global
to_indices
to_local
to_mask
SpheresAndCylinders
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
set_locations
show_hist
throats
to_global
to_indices
to_local
to_mask
SquaresAndRectangles
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
set_locations
show_hist
throats
to_global
to_indices
to_local
to_mask
TrapezoidsAndRectangles
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
set_locations
show_hist
throats
to_global
to_indices
to_local
to_mask
Phases
Air
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
GenericPhase
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
Mercury
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
MultiPhase
add_model
add_phases
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_binary_partition_coef
set_label
set_occupancy
show_hist
throats
to_indices
to_mask
Water
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
Mixtures
DryAir
add_model
check_mixture_health
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_component
set_concentration
set_label
set_mole_fraction
show_hist
throats
to_indices
to_mask
update_concentrations
update_mole_fractions
GasByName
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
GasMixture
add_model
check_mixture_health
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_component
set_concentration
set_label
set_mole_fraction
show_hist
throats
to_indices
to_mask
update_concentrations
update_mole_fractions
GenericMixture
add_model
check_mixture_health
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_component
set_concentration
set_label
set_mole_fraction
show_hist
throats
to_indices
to_mask
update_concentrations
update_mole_fractions
GenericSpecies
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
HumidAir
add_model
check_mixture_health
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_component
set_concentration
set_label
set_mole_fraction
show_hist
throats
to_indices
to_mask
update_concentrations
update_mole_fractions
IdealGas
add_model
check_mixture_health
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_component
set_concentration
set_label
set_mole_fraction
show_hist
throats
to_indices
to_mask
update_concentrations
update_mole_fractions
LiquidByName
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
LiquidMixture
add_model
check_mixture_health
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_component
set_concentration
set_label
set_mole_fraction
show_hist
throats
to_indices
to_mask
update_concentrations
update_mole_fractions
SalineWater
add_model
check_mixture_health
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_component
set_concentration
set_label
set_mole_fraction
show_hist
throats
to_indices
to_mask
update_concentrations
update_mole_fractions
SpeciesByName
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_label
show_hist
throats
to_indices
to_mask
Species
Gases
Ions
Liquids
Physics
Basic
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_geometry
set_label
set_locations
set_phase
show_hist
throats
to_global
to_indices
to_local
to_mask
GenericPhysics
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_geometry
set_label
set_locations
set_phase
show_hist
throats
to_global
to_indices
to_local
to_mask
Standard
add_model
filter_by_label
get_conduit_data
interleave_data
interpolate_data
labels
num_pores
num_throats
params
pores
props
regenerate_models
remove_model
set_geometry
set_label
set_locations
set_phase
show_hist
throats
to_global
to_indices
to_local
to_mask
Models
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
Substitution
Geometry
Conduit_lengths
circles_and_rectangles
cones_and_cylinders
cubes_and_cuboids
pyramids_and_cuboids
spheres_and_cylinders
squares_and_rectangles
trapezoids_and_rectangles
Docorator
Diffusive_size_factors
circles_and_rectangles
cones_and_cylinders
cubes_and_cuboids
intersecting_cones
intersecting_pyramids
intersecting_trapezoids
ncylinders_in_series
pyramids_and_cuboids
spheres_and_cylinders
squares_and_rectangles
trapezoids_and_rectangles
Docorator
Hydraulic_size_factors
circles_and_rectangles
cones_and_cylinders
cubes_and_cuboids
intersecting_cones
intersecting_pyramids
intersecting_trapezoids
ncylinders_in_series
pyramids_and_cuboids
spheres_and_cylinders
squares_and_rectangles
trapezoids_and_rectangles
Docorator
Pore_cross_sectional_area
circle
cone
cube
sphere
square
Docorator
Pore_seed
random
spatially_correlated
Docorator
Pore_size
equivalent_diameter
from_neighbor_throats
generic_distribution
largest_sphere
normal
random
weibull
Docorator
Pore_surface_area
circle
cube
sphere
square
Docorator
Pore_volume
circle
cube
effective
sphere
square
Docorator
Throat_capillary_shape_factor
compactness
jenkins_rao
mason_morrow
Docorator
Throat_centroid
pore_coords
Docorator
Throat_cross_sectional_area
cuboid
cylinder
rectangle
Docorator
Throat_length
circles_and_rectangles
cones_and_cylinders
cubes_and_cuboids
pyramids_and_cuboids
spheres_and_cylinders
squares_and_rectangles
trapezoids_and_rectangles
Docorator
Throat_perimeter
cuboid
cylinder
rectangle
Docorator
Throat_seed
from_neighbor_pores
random
Throat_size
equivalent_diameter
from_neighbor_pores
generic_distribution
normal
random
weibull
Docorator
Throat_surface_area
cuboid
cylinder
extrusion
rectangle
Docorator
Throat_vector
pore_to_pore
Docorator
Throat_volume
cuboid
cylinder
extrusion
lens
pendular_ring
rectangle
Docorator
Misc
blank
clip
constant
fraction
from_neighbor_pores
from_neighbor_throats
generic_distribution
generic_function
invert
linear
match_histogram
normal
normalize
polynomial
product
random
scaled
summation
weibull
Basic_math
blank
clip
constant
fraction
invert
normalize
product
scaled
summation
Neighbor_lookups
from_neighbor_pores
from_neighbor_throats
Simple_equations
generic_function
linear
polynomial
Statistical_distributions
generic_distribution
match_histogram
normal
random
weibull
Docorator
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
headless_throats
isolated_pores
looped_throats
pore_to_pore_distance
reduce_coordination
reversed_throats
Phases
Density
ideal_gas
standard
water
Docorator
Diffusivity
chapman_enskog
fuller
fuller_scaling
tyn_calus
tyn_calus_scaling
Docorator
Electrical_conductivity
percolating_continua
Docorator
Misc
mix_and_match
Docorator
Mixtures
fuller_diffusivity
mole_weighted_average
salinity
wilke_fuller_diffusivity
Docorator
MixDict
Molar_density
ideal_gas
standard
vanderwaals
Docorator
Partition_coefficient
gaseous_species_in_water
Docorator
Path
Permittivity
water
Docorator
Surface_tension
brock_bird_scaling
eotvos
guggenheim_katayama
water
Docorator
Thermal_conductivity
chung
sato
water
Docorator
Vapor_pressure
antoine
water
Docorator
Viscosity
chung
reynolds
water
Physics
Ad_dif_conductance
ad_dif
Ad_dif_mig_conductance
ad_dif_mig
Capillary_pressure
purcell
purcell_bidirectional
ransohoff_snap_off
sinusoidal_bidirectional
washburn
Diffusive_conductance
generic_diffusive
mixed_diffusion
multiphase_diffusion
ordinary_diffusion
taylor_aris_diffusion
Electrical_conductance
generic_electrical
series_resistors
Hydraulic_conductance
generic_hydraulic
hagen_poiseuille
hagen_poiseuille_power_law
valvatne_blunt
Ionic_conductance
electroneutrality
poisson
Meniscus
general_toroidal
purcell
sinusoidal
Multiphase
conduit_conductance
late_filling
Source_terms
butler_volmer_conc
butler_volmer_voltage
charge_conservation
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
ScipySpsolve
solve
Integrators
Integrator
ScipyRK45
solve
Solution
TransientSolution
interpolate
Algorithms
AdvectionDiffusion
get_conduit_data
interleave_data
interpolate_data
map_pores
map_throats
props
rate
remove_BC
remove_source
reset
results
run
set_outflow_BC
set_rate_BC
set_source
set_value_BC
set_variable_props
show_hist
to_indices
to_mask
toindices
tomask
FickianDiffusion
get_conduit_data
interleave_data
interpolate_data
map_pores
map_throats
props
rate
remove_BC
remove_source
reset
results
run
set_rate_BC
set_source
set_value_BC
set_variable_props
show_hist
to_indices
to_mask
toindices
tomask
FourierConduction
get_conduit_data
interleave_data
interpolate_data
map_pores
map_throats
props
rate
remove_BC
remove_source
reset
results
run
set_rate_BC
set_source
set_value_BC
set_variable_props
show_hist
to_indices
to_mask
toindices
tomask
GenericAlgorithm
get_conduit_data
interleave_data
interpolate_data
map_pores
map_throats
props
show_hist
to_indices
to_mask
toindices
tomask
GenericTransport
get_conduit_data
interleave_data
interpolate_data
map_pores
map_throats
props
rate
remove_BC
reset
results
run
set_rate_BC
set_value_BC
set_variable_props
show_hist
to_indices
to_mask
toindices
tomask
GenericTransportSettings
InvasionPercolation
apply_trapping
get_conduit_data
get_intrusion_data
interleave_data
interpolate_data
map_pores
map_throats
plot_intrusion_curve
props
results
run
set_inlets
show_hist
to_indices
to_mask
toindices
tomask
IonicConduction
get_conduit_data
interleave_data
interpolate_data
map_pores
map_throats
props
rate
remove_BC
remove_source
reset
results
run
set_rate_BC
set_source
set_value_BC
set_variable_props
show_hist
to_indices
to_mask
toindices
tomask
MixedInvasionPercolation
apply_flow
apply_trapping
get_conduit_data
get_intrusion_data
interleave_data
interpolate_data
map_pores
map_throats
plot_intrusion_curve
props
reset
results
run
set_inlets
set_outlets
set_residual
setup
show_hist
to_indices
to_mask
toindices
tomask
MixedInvasionPercolationCoop
apply_flow
apply_trapping
get_conduit_data
get_intrusion_data
interleave_data
interpolate_data
map_pores
map_throats
plot_intrusion_curve
props
reset
results
run
set_inlets
set_outlets
set_residual
setup
setup_coop_filling
show_hist
to_indices
to_mask
toindices
tomask
trilaterate_v
OhmicConduction
get_conduit_data
interleave_data
interpolate_data
map_pores
map_throats
props
rate
remove_BC
remove_source
reset
results
run
set_rate_BC
set_source
set_value_BC
set_variable_props
show_hist
to_indices
to_mask
toindices
tomask
OrdinaryPercolation
get_conduit_data
get_intrusion_data
get_percolation_threshold
interleave_data
interpolate_data
is_percolating
map_pores
map_throats
plot_intrusion_curve
props
reset
results
run
set_inlets
set_outlets
set_residual
show_hist
to_indices
to_mask
toindices
tomask
ReactiveTransport
get_conduit_data
interleave_data
interpolate_data
map_pores
map_throats
props
rate
remove_BC
remove_source
reset
results
run
set_rate_BC
set_source
set_value_BC
set_variable_props
show_hist
to_indices
to_mask
toindices
tomask
StokesFlow
get_conduit_data
interleave_data
interpolate_data
map_pores
map_throats
props
rate
remove_BC
remove_source
reset
results
run
set_rate_BC
set_source
set_value_BC
set_variable_props
show_hist
to_indices
to_mask
toindices
tomask
TransientAdvectionDiffusion
get_conduit_data
interleave_data
interpolate_data
map_pores
map_throats
props
rate
remove_BC
remove_source
reset
results
run
set_outflow_BC
set_rate_BC
set_source
set_value_BC
set_variable_props
show_hist
to_indices
to_mask
toindices
tomask
TransientFickianDiffusion
get_conduit_data
interleave_data
interpolate_data
map_pores
map_throats
props
rate
remove_BC
remove_source
reset
results
run
set_rate_BC
set_source
set_value_BC
set_variable_props
show_hist
to_indices
to_mask
toindices
tomask
TransientIonicConduction
get_conduit_data
interleave_data
interpolate_data
map_pores
map_throats
props
rate
remove_BC
remove_source
reset
results
run
set_rate_BC
set_source
set_value_BC
set_variable_props
show_hist
to_indices
to_mask
toindices
tomask
TransientReactiveTransport
get_conduit_data
interleave_data
interpolate_data
map_pores
map_throats
props
rate
remove_BC
remove_source
reset
results
run
set_rate_BC
set_source
set_value_BC
set_variable_props
show_hist
to_indices
to_mask
toindices
tomask
Topotools
add_boundary_pores
bond_percolation
clone_pores
connect_pores
conns_to_am
dimensionality
drop_sites
extend
filter_pores_by_z
find_clusters
find_complement
find_connected_sites
find_connecting_bonds
find_neighbor_bonds
find_neighbor_sites
find_path
find_pore_to_pore_distance
find_surface_pores
from_cylindrical
from_spherical
generate_base_points
generate_voxel_image
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
plot_connections
plot_coordinates
plot_network_jupyter
plot_networkx
plot_tutorial
plot_vpython
reflect_base_points
remove_isolated_clusters
rotate_coords
shear_coords
site_percolation
stitch
stitch_pores
subdivide
template_cylinder_annulus
template_sphere_shell
to_cylindrical
to_spherical
tri_to_am
trim
trim_occluded_throats
vor_to_am
Generators
bcc
cubic
cubic_template
delaunay
fcc
gabriel
voronoi
voronoi_delaunay_dual
Tools
add_all_label
crop
dimensionality
generate_base_points
get_shape
get_spacing
isoutside
join
label_faces
label_surface_nodes
parse_points
trim
Io
COMSOL
export_data
CSV
export_data
import_data
Dict
export_data
from_dict
import_data
to_dict
GenericIO
HDF5
export_data
JSONGraphFormat
export_data
import_data
MARock
import_data
MAT
export_data
import_data
NetworkX
export_data
import_data
PNM
Pandas
export_data
ParaView
export_data
open_paraview
PerGeos
Pickle
load_object_from_file
load_project
load_workspace
save_object_to_file
save_project
save_workspace
PoreSpy
import_data
STL
export_data
Salome
export_data
Statoil
add_reservoir_pore
export_data
import_data
VTK
export_data
import_data
XDMF
export_data
iMorph
import_data
Metrics
AbsolutePermeability
get_conduit_data
interleave_data
interpolate_data
props
run
show_hist
to_indices
to_mask
EffectiveDiffusivity
get_conduit_data
interleave_data
interpolate_data
props
run
show_hist
to_indices
to_mask
FormationFactor
get_conduit_data
interleave_data
interpolate_data
props
run
show_hist
to_indices
to_mask
GenericMetric
get_conduit_data
interleave_data
interpolate_data
props
show_hist
to_indices
to_mask
GenericTransportMetrics
get_conduit_data
interleave_data
interpolate_data
props
show_hist
to_indices
to_mask
MercuryIntrusion
get_conduit_data
get_intrusion_data
get_percolation_threshold
interleave_data
interpolate_data
is_percolating
map_pores
map_throats
plot_intrusion_curve
props
reset
run
set_inlets
set_outlets
set_partial_filling
set_residual
show_hist
to_indices
to_mask
toindices
tomask
PNFlow
run
Porosimetry
get_conduit_data
get_intrusion_data
get_percolation_threshold
interleave_data
interpolate_data
is_percolating
map_pores
map_throats
plot_intrusion_curve
props
reset
run
set_inlets
set_outlets
set_partial_filling
set_residual
show_hist
to_indices
to_mask
toindices
tomask
NestedDict
¶
class
openpnm.utils.misc.
NestedDict
(
mapping
=
{}
,
delimiter
=
'/'
)
[source]
¶
Brief explanation of ‘NestedDict’
Methods
to_dict
unravel