4.7.17 pde.tools.typing module

Provides support for mypy type checking of the package.

OperatorInfo	Stores information about an operator.
OperatorImplType	Represent a PEP 604 union type
OperatorFactory	A factory function that creates an operator for a particular grid.
OperatorType	An operator that acts on an array.
CellVolume
VirtualPointEvaluator
GhostCellSetter
DataSetter
StepperHook

class CellVolume(*args, **kwargs)

Bases: Protocol

class DataSetter(*args, **kwargs)

Bases: Protocol

class GhostCellSetter(*args, **kwargs)

Bases: Protocol

class InnerStepperType(*args, **kwargs)

Bases: Protocol

General backend-level stepping-function type working with numpy arrays.

class OperatorFactory(*args, **kwargs)

Bases: Protocol

A factory function that creates an operator for a particular grid.

class OperatorInfo(factory, rank_in, rank_out, name='')

Bases: NamedTuple

Stores information about an operator.

Create new instance of OperatorInfo(factory, rank_in, rank_out, name)

Parameters:

• factory (OperatorFactory)

• rank_in (int)

• rank_out (int)

• name (str)

factory: OperatorFactory

Alias for field number 0

name: str

Alias for field number 3

rank_in: int

Alias for field number 1

rank_out: int

Alias for field number 2

class OperatorType(*args, **kwargs)

Bases: Protocol

An operator that acts on an array.

class PostStepHook(*args, **kwargs)

Bases: Protocol

class StepperHook(*args, **kwargs)

Bases: Protocol

class StepperType(*args, **kwargs)

Bases: Protocol

General stepping-function type working with py-pde fields.

Instances of this protocol are typically created by solver objects.

class VirtualPointEvaluator(*args, **kwargs)

Bases: Protocol