Installation
User Guide
Module Reference
Examples
Issue Tracker
Get Help

GitHub
Substack
Twitter

Utils
Core
- Base
- LabelMixin
  - filter_by_label
  - labels
  - num_pores
  - num_throats
  - pores
  - set_label
  - throats
- LegacyMixin
- ModelsDict
- ModelsMixin
- 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
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
- 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
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
Solvers
- BaseSolver
  - solve
- DirectSolver
  - solve
- IterativeSolver
  - solve
- PETScLinearSolver
  - solve
- PardisoSpsolve
  - solve
- ScipySpsolve
  - solve
Integrators
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
- 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
- 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
Io
- COMSOL
  - export_data
- CSV
  - export_data
  - import_data
- 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
- PoreSpy
  - import_data
- STL
  - export_data
- Salome
  - export_data
- Statoil
- VTK
  - export_data
  - import_data
- XDMF
  - export_data
- iMorph
  - import_data
Metrics

This is a module

Permittivity¶

Functions

water(target)

Calculates the relative permittivity of saline water.

Classes

Brief explanation of 'Docorator'

© Copyright 2021, PMEAL.

Created using Sphinx 4.3.1.