stable
1. Getting started
1.1. Install using pip
1.2. Install using conda
1.3. Install from source
1.3.1. Required prerequisites
1.3.2. Optional packages
1.3.3. Downloading
py-pde
1.4. Package overview
2. Examples
2.1. Plotting a vector field
2.2. Solving Laplace’s equation in 2d
2.3. Plotting a scalar field in cylindrical coordinates
2.4. Solving Poisson’s equation in 1d
2.5. Simple diffusion equation
2.6. Kuramoto-Sivashinsky - Using
PDE
class
2.7. Spherically symmetric PDE
2.8. Diffusion on a Cartesian grid
2.9. Stochastic simulation
2.10. Time-dependent boundary conditions
2.11. Setting boundary conditions
2.12. 1D problem - Using
PDE
class
2.13. Heterogeneous boundary conditions
2.14. Brusselator - Using the
PDE
class
2.15. Writing and reading trajectory data
2.16. Diffusion equation with spatial dependence
2.17. Using simulation trackers
2.18. Schrödinger’s Equation
2.19. Kuramoto-Sivashinsky - Using custom class
2.20. Custom Class for coupled PDEs
2.21. 1D problem - Using custom class
2.22. Visualizing a scalar field
2.23. Kuramoto-Sivashinsky - Compiled methods
2.24. Solver comparison
2.25. Custom PDE class: SIR model
2.26. Brusselator - Using custom class
3. User manual
3.1. Mathematical basics
3.1.1. Curvilinear coordinates
3.1.1.1. Polar coordinates
3.1.1.2. Spherical coordinates
3.1.1.3. Cylindrical coordinates
3.1.2. Spatial discretization
3.1.3. Temporal evolution
3.2. Basic usage
3.2.1. Defining the geometry
3.2.2. Initializing a field
3.2.3. Specifying the PDE
3.2.4. Running the simulation
3.2.5. Analyzing the results
3.3. Advanced usage
3.3.1. Boundary conditions
3.3.2. Expressions
3.3.3. Custom PDE classes
3.3.4. Low-level operators
3.3.4.1. Differential operators
3.3.4.2. Field integration
3.3.4.3. Field interpolation
3.3.4.4. Inner products
3.3.5. Numba-accelerated PDEs
3.3.6. Configuration parameters
3.4. Performance
3.4.1. Measuring performance
3.4.2. Improving performance
3.4.3. Multiprocessing using MPI
3.5. Contributing code
3.5.1. Structure of the package
3.5.2. Extending functionality
3.5.3. Design choices
3.5.4. Coding style
3.5.5. Running unit tests
3.6. Citing the package
3.7. Code of Conduct
3.7.1. Our Pledge
3.7.2. Our Standards
3.7.3. Our Responsibilities
3.7.4. Scope
3.7.5. Enforcement
3.7.6. Attribution
4. Reference manual
4.1. pde.fields package
4.1.1. pde.fields.base module
4.1.2. pde.fields.collection module
4.1.3. pde.fields.scalar module
4.1.4. pde.fields.tensorial module
4.1.5. pde.fields.vectorial module
4.2. pde.grids package
4.2.1. pde.grids.boundaries package
4.2.1.1. Boundary conditions
4.2.1.2. Boundaries overview
4.2.1.3. pde.grids.boundaries.axes module
4.2.1.4. pde.grids.boundaries.axis module
4.2.1.5. pde.grids.boundaries.local module
4.2.2. pde.grids.operators package
4.2.2.1. pde.grids.operators.cartesian module
4.2.2.2. pde.grids.operators.common module
4.2.2.3. pde.grids.operators.cylindrical_sym module
4.2.2.4. pde.grids.operators.polar_sym module
4.2.2.5. pde.grids.operators.spherical_sym module
4.2.3. pde.grids.base module
4.2.4. pde.grids.cartesian module
4.2.5. pde.grids.cylindrical module
4.2.6. pde.grids.spherical module
4.3. pde.pdes package
4.3.1. pde.pdes.allen_cahn module
4.3.2. pde.pdes.base module
4.3.3. pde.pdes.cahn_hilliard module
4.3.4. pde.pdes.diffusion module
4.3.5. pde.pdes.kpz_interface module
4.3.6. pde.pdes.kuramoto_sivashinsky module
4.3.7. pde.pdes.laplace module
4.3.8. pde.pdes.pde module
4.3.9. pde.pdes.swift_hohenberg module
4.3.10. pde.pdes.wave module
4.4. pde.solvers package
4.4.1. pde.solvers.base module
4.4.2. pde.solvers.controller module
4.4.3. pde.solvers.explicit module
4.4.4. pde.solvers.explicit_mpi module
4.4.5. pde.solvers.implicit module
4.4.6. pde.solvers.scipy module
4.5. pde.storage package
4.5.1. pde.storage.base module
4.5.2. pde.storage.file module
4.5.3. pde.storage.memory module
4.6. pde.tools package
4.6.1. pde.tools.cache module
4.6.2. pde.tools.config module
4.6.3. pde.tools.cuboid module
4.6.4. pde.tools.docstrings module
4.6.5. pde.tools.expressions module
4.6.6. pde.tools.math module
4.6.7. pde.tools.misc module
4.6.8. pde.tools.mpi module
4.6.9. pde.tools.numba module
4.6.10. pde.tools.output module
4.6.11. pde.tools.parameters module
4.6.12. pde.tools.parse_duration module
4.6.13. pde.tools.plotting module
4.6.14. pde.tools.spectral module
4.6.15. pde.tools.typing module
4.7. pde.trackers package
4.7.1. pde.trackers.base module
4.7.2. pde.trackers.interactive module
4.7.3. pde.trackers.interrupts module
4.7.4. pde.trackers.trackers module
4.8. pde.visualization package
4.8.1. pde.visualization.movies module
4.8.2. pde.visualization.plotting module
py-pde
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
AdaptiveSolverBase (class in pde.solvers.base)
add_figure() (Movie method)
add_scaled_colorbar() (in module pde.tools.plotting)
AdjacentEvaluator (class in pde.tools.typing)
AllenCahnPDE (class in pde.pdes.allen_cahn)
append() (FieldCollection method)
(StorageBase method)
apply() (FieldBase method)
(StorageBase method)
apply_operator() (DataFieldBase method)
asanyarray_flags() (in module pde.tools.cuboid)
assert_field_compatible() (FieldBase method)
(FieldCollection method)
assert_grid_compatible() (GridBase method)
attributes (FieldBase property)
(FieldCollection property)
attributes_serialized (FieldBase property)
(FieldCollection property)
average (DataFieldBase property)
averages (FieldCollection property)
ax (PlotReference attribute)
axes (CylindricalSymGrid attribute)
(GridBase attribute)
(PolarSymGrid attribute)
(SphericalSymGrid attribute)
(SphericalSymGridBase attribute)
(UnitGrid attribute)
axes_bounds (GridBase property)
axes_coords (GridBase property)
axes_symmetric (CylindricalSymGrid attribute)
(GridBase attribute)
(PolarSymGrid attribute)
(SphericalSymGrid attribute)
axis (BoundaryAxisBase property)
axis_coord (BCBase property)
B
BasicOutput (class in pde.tools.output)
BasicPlottingContext (class in pde.tools.plotting)
BCBase (class in pde.grids.boundaries.local)
BCDataError
Boundaries (class in pde.grids.boundaries.axes)
boundary_names (CartesianGrid attribute)
(CylindricalSymGrid attribute)
(GridBase attribute)
(SphericalSymGridBase attribute)
BoundaryAxisBase (class in pde.grids.boundaries.axis)
BoundaryPair (class in pde.grids.boundaries.axis)
BoundaryPeriodic (class in pde.grids.boundaries.axis)
bounds (Cuboid property)
(SmoothData1D property)
buffer() (Cuboid method)
C
cache_rhs (PDEBase attribute)
cached_method (class in pde.tools.cache)
cached_property (class in pde.tools.cache)
CahnHilliardPDE (class in pde.pdes.cahn_hilliard)
CallbackTracker (class in pde.trackers.trackers)
CartesianGrid (class in pde.grids.cartesian)
cell_coords (GridBase attribute)
cell_volume_data (CartesianGrid property)
(CylindricalSymGrid attribute)
(GridBase attribute)
(PolarSymGrid attribute)
(SphericalSymGrid attribute)
(SphericalSymGridBase attribute)
cell_volumes (GridBase attribute)
CellVolume (class in pde.tools.typing)
centroid (Cuboid property)
check_implementation (PDEBase attribute)
check_length() (DictFiniteCapacity method)
check_package_version() (in module pde.tools.config)
check_rhs_consistency() (PDEBase method)
check_value_rank() (BCBase method)
(Boundaries method)
(BoundaryPair method)
(BoundaryPeriodic method)
class_type (OnlineStatistics attribute)
classmethod() (hybridmethod method)
classproperty (class in pde.tools.misc)
clear() (FileStorage method)
(MemoryStorage method)
(StorageBase method)
close() (FileStorage method)
(JupyterPlottingContext method)
(NapariViewer method)
(PlottingContextBase method)
compatible_with() (GridBase method)
complex (ExpressionBase property)
complex_valued (PDEBase attribute)
Config (class in pde.tools.config)
conjugate() (FieldBase method)
ConsistencyTracker (class in pde.trackers.trackers)
constant (ExpressionBase property)
ConstantInterrupts (class in pde.trackers.interrupts)
ConstBC1stOrderBase (class in pde.grids.boundaries.local)
ConstBC2ndOrderBase (class in pde.grids.boundaries.local)
ConstBCBase (class in pde.grids.boundaries.local)
contains_point() (Cuboid method)
(GridBase method)
Controller (class in pde.solvers)
(class in pde.solvers.controller)
ConvergenceError
convert() (Parameter method)
coordinate_arrays (GridBase attribute)
coordinate_constraints (CylindricalSymGrid attribute)
(GridBase attribute)
(PolarSymGrid attribute)
(SphericalSymGrid attribute)
copy() (BCBase method)
(Boundaries method)
(BoundaryAxisBase method)
(BoundaryPeriodic method)
(ConstantInterrupts method)
(ConstBCBase method)
(Cuboid method)
(DataFieldBase method)
(ExpressionBC method)
(FieldBase method)
(FieldCollection method)
(FixedInterrupts method)
(GridBase method)
(InterruptsBase method)
(MixedBC method)
(ScalarExpression method)
(StorageBase method)
(UserBC method)
corners (Cuboid property)
count (OnlineStatistics attribute)
Counter (class in pde.tools.numba)
cuboid (CartesianGrid attribute)
Cuboid (class in pde.tools.cuboid)
cuboid (UnitGrid attribute)
CurvatureBC (class in pde.grids.boundaries.local)
CylindricalSymGrid (class in pde.grids.cylindrical)
D
data (DataTracker attribute)
(FieldBase property)
(FileStorage property)
(MemoryStorage attribute)
(StorageBase attribute)
data_shape (DataFieldBase property)
(StorageBase property)
DataFieldBase (class in pde.fields.base)
dataframe (DataTracker property)
DataTracker (class in pde.trackers.trackers)
decorator_arguments() (in module pde.tools.misc)
default_capacity (DictFiniteCapacity attribute)
deleter() (classproperty method)
depends_on() (ExpressionBase method)
DeprecatedParameter (class in pde.tools.parameters)
derivative() (SmoothData1D method)
derivatives (ScalarExpression attribute)
(TensorExpression attribute)
diagnostics (CahnHilliardPDE attribute)
(Controller attribute)
,
[1]
(DiffusionPDE attribute)
(KPZInterfacePDE attribute)
(KuramotoSivashinskyPDE attribute)
(PDE attribute)
(PDEBase attribute)
(SwiftHohenbergPDE attribute)
(WavePDE attribute)
diagonal (Cuboid property)
DictFiniteCapacity (class in pde.tools.cache)
difference_vector_real() (GridBase method)
differentiate() (ScalarExpression method)
(TensorExpression method)
DiffusionPDE (class in pde.pdes.diffusion)
dim (Cuboid property)
(CylindricalSymGrid attribute)
(GridBase attribute)
(PolarSymGrid attribute)
(SphericalSymGrid attribute)
(SphericalSymGridBase attribute)
(UnitGrid attribute)
DimensionError
DirichletBC (class in pde.grids.boundaries.local)
disable_interactive() (in module pde.tools.plotting)
discretization (GridBase property)
discretize_interval() (in module pde.grids.base)
display_progress() (in module pde.tools.output)
distance_real() (GridBase method)
divergence() (Tensor2Field method)
(VectorField method)
DomainError
dot() (Tensor2Field method)
(VectorField method)
dt (ConstantInterrupts attribute)
(FixedInterrupts attribute)
(InterruptsBase attribute)
(LogarithmicInterrupts attribute)
(RealtimeInterrupts attribute)
dt_default (SolverBase attribute)
dt_max (AdaptiveSolverBase attribute)
dt_min (AdaptiveSolverBase attribute)
dtype (FieldBase property)
(StorageBase property)
E
element (PlotReference attribute)
end_writing() (FileStorage method)
(StorageBase method)
ensure_directory_exists() (in module pde.tools.misc)
environment variable
PYTHONPATH
environment() (in module pde.tools.config)
estimate_computation_speed() (in module pde.tools.misc)
evaluate() (in module pde.tools.expressions)
evolution_rate() (AllenCahnPDE method)
(CahnHilliardPDE method)
(DiffusionPDE method)
(KPZInterfacePDE method)
(KuramotoSivashinskyPDE method)
(PDE method)
(PDEBase method)
(SwiftHohenbergPDE method)
(WavePDE method)
explicit_time_dependence (AllenCahnPDE attribute)
(CahnHilliardPDE attribute)
(DiffusionPDE attribute)
(KPZInterfacePDE attribute)
(KuramotoSivashinskyPDE attribute)
(PDEBase attribute)
(SwiftHohenbergPDE attribute)
(WavePDE attribute)
ExplicitMPISolver (class in pde.solvers.explicit_mpi)
ExplicitSolver (class in pde.solvers)
(class in pde.solvers.explicit)
expr_prod() (in module pde.pdes.base)
expression (AllenCahnPDE property)
(CahnHilliardPDE property)
(DiffusionPDE property)
(ExpressionBase property)
(KPZInterfacePDE property)
(KuramotoSivashinskyPDE property)
(SwiftHohenbergPDE property)
ExpressionBase (class in pde.tools.expressions)
ExpressionBC (class in pde.grids.boundaries.local)
ExpressionDerivativeBC (class in pde.grids.boundaries.local)
ExpressionMixedBC (class in pde.grids.boundaries.local)
expressions (PDE property)
(WavePDE property)
ExpressionValueBC (class in pde.grids.boundaries.local)
extract_field() (in module pde.visualization.plotting)
(StorageBase method)
extract_time_range() (StorageBase method)
F
factory (OperatorInfo attribute)
FieldBase (class in pde.fields.base)
FieldCollection (class in pde.fields.collection)
fields (FieldCollection property)
FileStorage (class in pde.storage.file)
fill_in_docstring() (in module pde.tools.docstrings)
finalize() (DataTracker method)
(InteractivePlotTracker method)
(PlotTracker method)
(ProgressTracker method)
(StorageTracker method)
(TrackerBase method)
(TrackerCollection method)
FinishedSimulation
FixedInterrupts (class in pde.trackers.interrupts)
flat_idx() (in module pde.tools.numba)
flip_sign (BoundaryPeriodic property)
fluctuations (DataFieldBase property)
from_bounds() (CartesianGrid class method)
(Cuboid class method)
(CylindricalSymGrid class method)
(GridBase class method)
(SphericalSymGridBase class method)
from_centerpoint() (Cuboid class method)
from_collection() (MemoryStorage class method)
from_data() (BCBase class method)
(Boundaries class method)
(BoundaryPair class method)
(FieldCollection class method)
(TrackerBase class method)
(TrackerCollection class method)
from_dict() (BCBase class method)
(FieldCollection class method)
from_expression() (ScalarField class method)
(Tensor2Field class method)
(VectorField class method)
from_fields() (MemoryStorage class method)
from_file() (FieldBase class method)
from_image() (ScalarField class method)
from_name() (SolverBase class method)
from_points() (Cuboid class method)
from_polar_coordinates() (CartesianGrid method)
from_scalar_expressions() (FieldCollection class method)
from_scalars() (VectorField class method)
from_state() (CartesianGrid class method)
(CylindricalSymGrid class method)
(DataFieldBase class method)
(FieldBase class method)
(FieldCollection class method)
(GridBase class method)
(SphericalSymGridBase class method)
(UnitGrid class method)
from_storage() (ScalarFieldPlot class method)
from_str() (BCBase class method)
G
get_all_parameters() (in module pde.tools.parameters)
get_axis_index() (GridBase method)
get_boundary_axis() (in module pde.grids.boundaries.axis)
get_boundary_conditions() (GridBase method)
get_boundary_field() (ScalarField method)
get_boundary_values() (DataFieldBase method)
get_cartesian_grid() (CylindricalSymGrid method)
(SphericalSymGridBase method)
get_class_by_rank() (DataFieldBase class method)
get_common_dtype() (in module pde.tools.misc)
get_common_numba_dtype() (in module pde.tools.numba)
get_compiled() (ExpressionBase method)
get_compiled_array() (TensorExpression method)
get_data() (BCBase method)
(BoundaryAxisBase method)
(ConstBC1stOrderBase method)
(ConstBC2ndOrderBase method)
(ExpressionBC method)
get_help() (BCBase class method)
(Boundaries class method)
(BoundaryAxisBase class method)
get_image_data() (CartesianGrid method)
(CylindricalSymGrid method)
(DataFieldBase method)
(FieldBase method)
(FieldCollection method)
(GridBase method)
(SphericalSymGridBase method)
get_initial_condition() (WavePDE method)
get_line_data() (CartesianGrid method)
(CylindricalSymGrid method)
(DataFieldBase method)
(FieldBase method)
(FieldCollection method)
(GridBase method)
(SphericalSymGridBase method)
get_mathematical_representation() (BCBase method)
(Boundaries method)
(BoundaryAxisBase method)
(CurvatureBC method)
(DirichletBC method)
(ExpressionBC method)
(MixedBC method)
(NeumannBC method)
(UserBC method)
get_memory_storage() (in module pde.storage.memory)
get_named_trackers() (in module pde.trackers.base)
get_package_versions() (in module pde.tools.config)
get_parameter_default() (Parameterized method)
get_parameters() (Parameterized class method)
get_plotting_context() (in module pde.tools.plotting)
get_progress_bar_class() (in module pde.tools.output)
get_random_point() (CartesianGrid method)
(CylindricalSymGrid method)
(GridBase method)
(SphericalSymGridBase method)
get_text_block() (in module pde.tools.docstrings)
get_vector_data() (DataFieldBase method)
(VectorField method)
get_virtual_point() (BCBase method)
(ConstBC1stOrderBase method)
(ConstBC2ndOrderBase method)
(ExpressionBC method)
get_virtual_point_data() (ConstBC1stOrderBase method)
(ConstBC2ndOrderBase method)
(CurvatureBC method)
(DirichletBC method)
(MixedBC method)
(NeumannBC method)
getter() (classproperty method)
GhostCellSetter (class in pde.tools.typing)
gradient() (ScalarField method)
(VectorField method)
gradient_squared() (ScalarField method)
grid (Boundaries attribute)
(BoundaryAxisBase property)
(FieldBase property)
(StorageBase property)
GridBase (class in pde.grids.base)
H
handle() (CallbackTracker method)
(ConsistencyTracker method)
(DataTracker method)
(InteractivePlotTracker method)
(MaterialConservationTracker method)
(PlotTracker method)
(PrintTracker method)
(ProgressTracker method)
(RuntimeTracker method)
(SteadyStateTracker method)
(StorageTracker method)
(TrackerBase method)
(TrackerCollection method)
has_collection (StorageBase property)
has_hole (CylindricalSymGrid property)
(SphericalSymGridBase property)
hash_mutable() (in module pde.tools.cache)
hash_readable() (in module pde.tools.cache)
hdf_write_attributes() (in module pde.tools.misc)
HideParameter (class in pde.tools.parameters)
high (BoundaryAxisBase attribute)
(BoundaryPair attribute)
(BoundaryPeriodic attribute)
homogeneous (BCBase attribute)
(CurvatureBC attribute)
(DirichletBC attribute)
(ExpressionBC attribute)
(ExpressionDerivativeBC attribute)
(ExpressionMixedBC attribute)
(ExpressionValueBC attribute)
(MixedBC attribute)
(NeumannBC attribute)
(NormalCurvatureBC attribute)
(NormalDirichletBC attribute)
(NormalMixedBC attribute)
(NormalNeumannBC attribute)
(UserBC attribute)
hybridmethod (class in pde.tools.misc)
I
imag (FieldBase property)
ImplicitSolver (class in pde.solvers)
(class in pde.solvers.implicit)
import_class() (in module pde.tools.misc)
in_ipython() (in module pde.tools.plotting)
in_jupyter_notebook() (in module pde.tools.output)
increment() (Counter method)
info (Controller attribute)
(ExplicitMPISolver attribute)
(ExplicitSolver attribute)
(ImplicitSolver attribute)
(ScipySolver attribute)
initialize() (ConstantInterrupts method)
(FixedInterrupts method)
(InteractivePlotTracker method)
(InterruptsBase method)
(MaterialConservationTracker method)
(PlotTracker method)
(ProgressTracker method)
(RealtimeInterrupts method)
(RuntimeTracker method)
(StorageTracker method)
(TrackerBase method)
(TrackerCollection method)
initialized (in module pde.tools.mpi)
insert() (DataFieldBase method)
instancemethod() (hybridmethod method)
integral (DataFieldBase property)
(ScalarField property)
(Tensor2Field property)
(VectorField property)
integrals (FieldCollection property)
integrate() (GridBase method)
InteractivePlotTracker (class in pde.trackers.interactive)
interface_width (AllenCahnPDE attribute)
interpolate() (DataFieldBase method)
interpolate_to_grid() (DataFieldBase method)
(FieldCollection method)
InterruptsBase (class in pde.trackers.interrupts)
interval_to_interrupts() (in module pde.trackers.interrupts)
is_available() (Movie class method)
is_complex (FieldBase property)
is_main (in module pde.tools.mpi)
is_sde (PDEBase property)
is_zero (ScalarExpression property)
items() (StorageBase method)
iter_mirror_points() (CartesianGrid method)
(CylindricalSymGrid method)
(GridBase method)
(SphericalSymGridBase method)
J
jit() (in module pde.tools.numba)
JupyterOutput (class in pde.tools.output)
JupyterPlottingContext (class in pde.tools.plotting)
K
KPZInterfacePDE (class in pde.pdes.kpz_interface)
KuramotoSivashinskyPDE (class in pde.pdes.kuramoto_sivashinsky)
L
label (FieldBase property)
labels (FieldCollection property)
laplace() (ScalarField method)
(VectorField method)
length (CylindricalSymGrid property)
link_value() (ConstBCBase method)
LivePlotTracker (class in pde.trackers.trackers)
LogarithmicInterrupts (class in pde.trackers.interrupts)
low (BoundaryAxisBase attribute)
(BoundaryPair attribute)
(BoundaryPeriodic attribute)
M
magnitude (DataFieldBase property)
magnitudes (FieldCollection property)
make_adjacent_evaluator() (BCBase method)
(ConstBC1stOrderBase method)
(ConstBC2ndOrderBase method)
(ExpressionBC method)
make_array_constructor() (in module pde.tools.numba)
make_cell_volume_compiled() (GridBase method)
make_colored_noise() (in module pde.tools.spectral)
make_divergence() (in module pde.grids.operators.cartesian)
(in module pde.grids.operators.cylindrical_sym)
(in module pde.grids.operators.polar_sym)
(in module pde.grids.operators.spherical_sym)
make_dot_operator() (DataFieldBase method)
make_general_poisson_solver() (in module pde.grids.operators.common)
make_ghost_cell_sender() (BCBase method)
make_ghost_cell_setter() (BCBase method)
(Boundaries method)
(BoundaryAxisBase method)
(UserBC method)
make_gradient() (in module pde.grids.operators.cartesian)
(in module pde.grids.operators.cylindrical_sym)
(in module pde.grids.operators.polar_sym)
(in module pde.grids.operators.spherical_sym)
make_gradient_squared() (in module pde.grids.operators.cylindrical_sym)
(in module pde.grids.operators.polar_sym)
(in module pde.grids.operators.spherical_sym)
make_inserter_compiled() (GridBase method)
make_integrator() (GridBase method)
make_interpolator() (DataFieldBase method)
make_laplace() (in module pde.grids.operators.cartesian)
(in module pde.grids.operators.cylindrical_sym)
(in module pde.grids.operators.polar_sym)
(in module pde.grids.operators.spherical_sym)
make_laplace_from_matrix() (in module pde.grids.operators.common)
make_modify_after_step() (PDEBase method)
make_movie() (ScalarFieldPlot method)
make_normalize_point_compiled() (GridBase method)
make_operator() (GridBase method)
make_operator_no_bc() (GridBase method)
make_outer_prod_operator() (VectorField method)
make_pde_rhs() (PDEBase method)
make_poisson_solver() (in module pde.grids.operators.cartesian)
(in module pde.grids.operators.cylindrical_sym)
(in module pde.grids.operators.polar_sym)
(in module pde.grids.operators.spherical_sym)
make_sde_rhs() (PDEBase method)
make_serializer() (in module pde.tools.cache)
make_stepper() (AdaptiveSolverBase method)
(ExplicitMPISolver method)
(ScipySolver method)
,
[1]
(SolverBase method)
make_tensor_divergence() (in module pde.grids.operators.cartesian)
(in module pde.grids.operators.cylindrical_sym)
(in module pde.grids.operators.polar_sym)
(in module pde.grids.operators.spherical_sym)
make_tensor_double_divergence() (in module pde.grids.operators.spherical_sym)
make_unserializer() (in module pde.tools.cache)
make_vector_gradient() (in module pde.grids.operators.cartesian)
(in module pde.grids.operators.cylindrical_sym)
(in module pde.grids.operators.polar_sym)
(in module pde.grids.operators.spherical_sym)
make_vector_laplace() (in module pde.grids.operators.cartesian)
(in module pde.grids.operators.cylindrical_sym)
make_virtual_point_evaluator() (BCBase method)
(ConstBC1stOrderBase method)
(ConstBC2ndOrderBase method)
(ExpressionBC method)
(UserBC method)
MaterialConservationTracker (class in pde.trackers.trackers)
mean (OnlineStatistics attribute)
MemoryStorage (class in pde.storage.memory)
MixedBC (class in pde.grids.boundaries.local)
module
pde
pde.fields
pde.fields.base
pde.fields.collection
pde.fields.scalar
pde.fields.tensorial
pde.fields.vectorial
pde.grids
pde.grids.base
pde.grids.boundaries
pde.grids.boundaries.axes
pde.grids.boundaries.axis
pde.grids.boundaries.local
pde.grids.cartesian
pde.grids.cylindrical
pde.grids.operators
pde.grids.operators.cartesian
pde.grids.operators.common
pde.grids.operators.cylindrical_sym
pde.grids.operators.polar_sym
pde.grids.operators.spherical_sym
pde.grids.spherical
pde.pdes
pde.pdes.allen_cahn
pde.pdes.base
pde.pdes.cahn_hilliard
pde.pdes.diffusion
pde.pdes.kpz_interface
pde.pdes.kuramoto_sivashinsky
pde.pdes.laplace
pde.pdes.pde
pde.pdes.swift_hohenberg
pde.pdes.wave
pde.solvers
pde.solvers.base
pde.solvers.controller
pde.solvers.explicit
pde.solvers.explicit_mpi
pde.solvers.implicit
pde.solvers.scipy
pde.storage
pde.storage.base
pde.storage.file
pde.storage.memory
pde.tools
pde.tools.cache
pde.tools.config
pde.tools.cuboid
pde.tools.docstrings
pde.tools.expressions
pde.tools.math
pde.tools.misc
pde.tools.mpi
pde.tools.numba
pde.tools.output
pde.tools.parameters
pde.tools.parse_duration
pde.tools.plotting
pde.tools.spectral
pde.tools.typing
pde.trackers
pde.trackers.base
pde.trackers.interactive
pde.trackers.interrupts
pde.trackers.trackers
pde.visualization
pde.visualization.movies
pde.visualization.plotting
module_available() (in module pde.tools.misc)
Movie (class in pde.visualization.movies)
movie() (in module pde.visualization.movies)
movie_multiple() (in module pde.visualization.movies)
movie_scalar() (in module pde.visualization.movies)
mpi_allreduce() (in module pde.tools.mpi)
mpi_recv() (in module pde.tools.mpi)
mpi_send() (in module pde.tools.mpi)
mutable (Cuboid property)
N
name (ConsistencyTracker attribute)
(ExplicitMPISolver attribute)
(ExplicitSolver attribute)
,
[1]
(ImplicitSolver attribute)
,
[1]
(InteractivePlotTracker attribute)
(LivePlotTracker attribute)
(MaterialConservationTracker attribute)
(OperatorInfo attribute)
(PrintTracker attribute)
(ProgressTracker attribute)
(ScipySolver attribute)
,
[1]
(SteadyStateTracker attribute)
names (BCBase attribute)
(CurvatureBC attribute)
(DirichletBC attribute)
(ExpressionBC attribute)
(ExpressionDerivativeBC attribute)
(ExpressionMixedBC attribute)
(ExpressionValueBC attribute)
(MixedBC attribute)
(NeumannBC attribute)
(NormalCurvatureBC attribute)
(NormalDirichletBC attribute)
(NormalMixedBC attribute)
(NormalNeumannBC attribute)
(UserBC attribute)
napari_add_layers() (in module pde.tools.plotting)
napari_process() (in module pde.trackers.interactive)
napari_viewer() (in module pde.tools.plotting)
NapariViewer (class in pde.trackers.interactive)
nested_plotting_check (class in pde.tools.plotting)
NeumannBC (class in pde.grids.boundaries.local)
next() (ConstantInterrupts method)
(FixedInterrupts method)
(InterruptsBase method)
(LogarithmicInterrupts method)
(RealtimeInterrupts method)
noise_realization() (PDEBase method)
normal (BCBase attribute)
(NormalCurvatureBC attribute)
(NormalDirichletBC attribute)
(NormalMixedBC attribute)
(NormalNeumannBC attribute)
NormalCurvatureBC (class in pde.grids.boundaries.local)
NormalDirichletBC (class in pde.grids.boundaries.local)
normalize_point() (GridBase method)
NormalMixedBC (class in pde.grids.boundaries.local)
NormalNeumannBC (class in pde.grids.boundaries.local)
num_axes (CylindricalSymGrid attribute)
(GridBase attribute)
(SphericalSymGridBase attribute)
(UnitGrid attribute)
num_cells (GridBase property)
numba_dict() (in module pde.tools.numba)
numba_environment() (in module pde.tools.numba)
numba_type (GridBase property)
number() (in module pde.tools.misc)
number_array() (in module pde.tools.misc)
O
objects_equal() (in module pde.tools.cache)
ol_flat_idx() (in module pde.tools.numba)
ol_mpi_allreduce() (in module pde.tools.mpi)
ol_mpi_recv() (in module pde.tools.mpi)
ol_mpi_send() (in module pde.tools.mpi)
OnlineStatistics (class in pde.tools.math)
OperatorFactory (class in pde.tools.typing)
OperatorInfo (class in pde.grids.base)
operators (GridBase attribute)
OperatorType (class in pde.tools.typing)
outer_product() (VectorField method)
OutputBase (class in pde.tools.output)
P
packages_from_requirements() (in module pde.tools.config)
parallel_run (in module pde.tools.mpi)
Parameter (class in pde.tools.parameters)
Parameterized (class in pde.tools.parameters)
parameters (PlotReference attribute)
parameters_default (Parameterized attribute)
parse_duration() (in module pde.tools.parse_duration)
parse_number() (in module pde.tools.expressions)
parse_version_str() (in module pde.tools.config)
pde
module
PDE (class in pde.pdes.pde)
pde.fields
module
pde.fields.base
module
pde.fields.collection
module
pde.fields.scalar
module
pde.fields.tensorial
module
pde.fields.vectorial
module
pde.grids
module
pde.grids.base
module
pde.grids.boundaries
module
pde.grids.boundaries.axes
module
pde.grids.boundaries.axis
module
pde.grids.boundaries.local
module
pde.grids.cartesian
module
pde.grids.cylindrical
module
pde.grids.operators
module
pde.grids.operators.cartesian
module
pde.grids.operators.common
module
pde.grids.operators.cylindrical_sym
module
pde.grids.operators.polar_sym
module
pde.grids.operators.spherical_sym
module
pde.grids.spherical
module
pde.pdes
module
pde.pdes.allen_cahn
module
pde.pdes.base
module
pde.pdes.cahn_hilliard
module
pde.pdes.diffusion
module
pde.pdes.kpz_interface
module
pde.pdes.kuramoto_sivashinsky
module
pde.pdes.laplace
module
pde.pdes.pde
module
pde.pdes.swift_hohenberg
module
pde.pdes.wave
module
pde.solvers
module
pde.solvers.base
module
pde.solvers.controller
module
pde.solvers.explicit
module
pde.solvers.explicit_mpi
module
pde.solvers.implicit
module
pde.solvers.scipy
module
pde.storage
module
pde.storage.base
module
pde.storage.file
module
pde.storage.memory
module
pde.tools
module
pde.tools.cache
module
pde.tools.config
module
pde.tools.cuboid
module
pde.tools.docstrings
module
pde.tools.expressions
module
pde.tools.math
module
pde.tools.misc
module
pde.tools.mpi
module
pde.tools.numba
module
pde.tools.output
module
pde.tools.parameters
module
pde.tools.parse_duration
module
pde.tools.plotting
module
pde.tools.spectral
module
pde.tools.typing
module
pde.trackers
module
pde.trackers.base
module
pde.trackers.interactive
module
pde.trackers.interrupts
module
pde.trackers.trackers
module
pde.visualization
module
pde.visualization.movies
module
pde.visualization.plotting
module
PDEBase (class in pde.pdes.base)
periodic (BCBase property)
(Boundaries property)
(BoundaryAxisBase property)
(GridBase property)
PeriodicityError
plot() (CartesianGrid method)
(DataFieldBase method)
(FieldBase method)
(FieldCollection method)
(GridBase method)
(SphericalSymGridBase method)
plot_components() (Tensor2Field method)
plot_interactive() (FieldBase method)
(in module pde.visualization.plotting)
plot_kymograph() (in module pde.visualization.plotting)
plot_kymographs() (in module pde.visualization.plotting)
plot_magnitudes() (in module pde.visualization.plotting)
plot_on_axes() (in module pde.tools.plotting)
plot_on_figure() (in module pde.tools.plotting)
PlotReference (class in pde.tools.plotting)
PlottingContextBase (class in pde.tools.plotting)
PlotTracker (class in pde.trackers.trackers)
point_from_cartesian() (CartesianGrid method)
(CylindricalSymGrid method)
(GridBase method)
(SphericalSymGridBase method)
point_to_cartesian() (CartesianGrid method)
(CylindricalSymGrid method)
(GridBase method)
(PolarSymGrid method)
(SphericalSymGrid method)
polar_coordinates_real() (CartesianGrid method)
(CylindricalSymGrid method)
(GridBase method)
(SphericalSymGridBase method)
PolarSymGrid (class in pde.grids.spherical)
preserve_scalars() (in module pde.tools.misc)
PrintTracker (class in pde.trackers.trackers)
progress_bar_format (SteadyStateTracker attribute)
ProgressTracker (class in pde.trackers.trackers)
project() (ScalarField method)
PYTHONPATH
R
radius (CylindricalSymGrid property)
(SphericalSymGridBase property)
random_colored() (DataFieldBase class method)
random_harmonic() (DataFieldBase class method)
random_normal() (DataFieldBase class method)
random_seed() (in module pde.tools.numba)
random_uniform() (DataFieldBase class method)
rank (BoundaryAxisBase property)
(DataFieldBase attribute)
(ExpressionBase property)
(in module pde.tools.mpi)
(ScalarField attribute)
(Tensor2Field attribute)
(TensorExpression property)
(VectorField attribute)
rank_in (OperatorInfo attribute)
rank_out (OperatorInfo attribute)
RankError
real (FieldBase property)
RealtimeInterrupts (class in pde.trackers.interrupts)
register_operator() (GridBase class method)
registered_boundary_condition_classes() (in module pde.grids.boundaries.local)
registered_boundary_condition_names() (in module pde.grids.boundaries.local)
registered_operators() (in module pde.grids.base)
registered_solvers (SolverBase attribute)
registered_solvers() (in module pde.solvers)
replace_in_docstring() (in module pde.tools.docstrings)
run() (Controller method)
,
[1]
RuntimeTracker (class in pde.trackers.trackers)
S
save() (Movie method)
savefig() (ScalarFieldPlot method)
scalar_random_uniform() (FieldCollection class method)
ScalarExpression (class in pde.tools.expressions)
ScalarField (class in pde.fields.scalar)
ScalarFieldPlot (class in pde.visualization.plotting)
ScipySolver (class in pde.solvers)
(class in pde.solvers.scipy)
SerializedDict (class in pde.tools.cache)
set_ghost_cells() (BCBase method)
(Boundaries method)
(BoundaryAxisBase method)
(ConstBC1stOrderBase method)
(ConstBC2ndOrderBase method)
(DataFieldBase method)
(ExpressionBC method)
(UserBC method)
setter() (classproperty method)
shape (ExpressionBase property)
(GridBase property)
(ScalarExpression attribute)
(StorageBase property)
(TensorExpression property)
show() (BasicOutput method)
(JupyterOutput method)
(OutputBase method)
show_parameters() (Parameterized method)
sigma_auto_scale (SmoothData1D attribute)
size (Cuboid property)
(in module pde.tools.mpi)
skipUnlessModule() (in module pde.tools.misc)
slice() (CartesianGrid method)
(CylindricalSymGrid method)
(GridBase method)
(ScalarField method)
(UnitGrid method)
smooth() (DataFieldBase method)
(FieldCollection method)
SmoothData1D (class in pde.tools.math)
solve() (PDEBase method)
solve_laplace_equation() (in module pde.pdes.laplace)
solve_poisson_equation() (in module pde.pdes.laplace)
SolverBase (class in pde.solvers.base)
SphericalSymGrid (class in pde.grids.spherical)
SphericalSymGridBase (class in pde.grids.spherical)
sphinx_display_parameters() (in module pde.tools.parameters)
split_mpi() (FieldBase method)
start_writing() (FileStorage method)
(MemoryStorage method)
(StorageBase method)
state (CartesianGrid property)
(CylindricalSymGrid property)
(GridBase property)
(SphericalSymGridBase property)
(UnitGrid property)
state_serialized (GridBase property)
SteadyStateTracker (class in pde.trackers.trackers)
storage (StorageTracker attribute)
StorageBase (class in pde.storage.base)
StorageTracker (class in pde.storage.base)
supports_update (JupyterPlottingContext attribute)
(PlottingContextBase attribute)
surface_area (Cuboid property)
SwiftHohenbergPDE (class in pde.pdes.swift_hohenberg)
symmetrize() (Tensor2Field method)
T
t_range (Controller property)
,
[1]
Tensor2Field (class in pde.fields.tensorial)
TensorExpression (class in pde.tools.expressions)
time_next_action (TrackerCollection attribute)
times (DataTracker attribute)
(FileStorage property)
(MemoryStorage attribute)
(StorageBase attribute)
to_cartesian() (UnitGrid method)
to_dict() (Config method)
to_file() (DataTracker method)
(FieldBase method)
to_scalar() (DataFieldBase method)
(ScalarField method)
(Tensor2Field method)
(VectorField method)
to_subgrid() (BCBase method)
(ConstBCBase method)
(ExpressionBC method)
(MixedBC method)
(UserBC method)
trace() (Tensor2Field method)
tracker() (StorageBase method)
tracker_action_times (TrackerCollection attribute)
TrackerBase (class in pde.trackers.base)
TrackerCollection (class in pde.trackers.base)
trackers (TrackerCollection attribute)
transform() (GridBase method)
transpose() (Tensor2Field method)
typical_discretization (GridBase property)
U
uniform_cell_volumes (GridBase attribute)
uniform_discretization() (in module pde.grids.operators.common)
UnitGrid (class in pde.grids.cartesian)
unserialize_attributes() (DataFieldBase class method)
(FieldBase class method)
(FieldCollection class method)
update() (DictFiniteCapacity method)
(NapariViewer method)
(ScalarFieldPlot method)
UserBC (class in pde.grids.boundaries.local)
V
value (ConstBCBase property)
(ScalarExpression property)
(TensorExpression property)
value_is_linked (ConstBC1stOrderBase attribute)
(ConstBC2ndOrderBase attribute)
(ConstBCBase attribute)
(CurvatureBC attribute)
(DirichletBC attribute)
(MixedBC attribute)
(NeumannBC attribute)
(NormalCurvatureBC attribute)
(NormalDirichletBC attribute)
(NormalMixedBC attribute)
(NormalNeumannBC attribute)
variables (PDE attribute)
VectorField (class in pde.fields.vectorial)
vertices (Cuboid property)
VirtualPointEvaluator (class in pde.tools.typing)
volume (CartesianGrid property)
(Cuboid property)
(CylindricalSymGrid property)
(GridBase property)
(SphericalSymGridBase property)
volume_from_radius() (in module pde.grids.spherical)
W
WavePDE (class in pde.pdes.wave)
write_mode (FileStorage attribute)
(MemoryStorage attribute)
(StorageBase attribute)
writeable (FieldBase property)
Read the Docs
v: stable
Versions
latest
stable
0.33.0
0.32.2
0.32.1
0.32.0
0.31.0
0.30.1
0.30.0
0.29.0
0.28.0
0.27.1
0.27.0
0.26.0
0.25.0
0.24.15
v0.23.0
v0.22.6
v0.21.0
v0.20.0
v0.19.2
v0.18.0
v0.17.3
Downloads
pdf
epub
On Read the Docs
Project Home
Builds