pmmoto package

PMMoTo package initialization.

This module sets up the logger and imports all major subpackages, making core functionality available at the top level.

Exports:

  • logger: The package-level logger.

  • initialize: Main initialization function for PMMoTo domains.

class pmmoto.BoundaryType(value)

Bases: str, Enum

Allowable boundary types.

END = 'end'
INTERNAL = 'internal'
PERIODIC = 'periodic'
WALL = 'wall'
pmmoto.initialize(voxels: tuple[int, ...], box: tuple[tuple[float, float], ...] = ((0, 1.0), (0, 1.0), (0, 1)), subdomains: tuple[int, ...] = (1, 1, 1), boundary_types: tuple[tuple[BoundaryType, BoundaryType], ...] = ((BoundaryType.END, BoundaryType.END), (BoundaryType.END, BoundaryType.END), (BoundaryType.END, BoundaryType.END)), inlet: tuple[tuple[bool, bool], ...] = ((False, False), (False, False), (False, False)), outlet: tuple[tuple[bool, bool], ...] = ((False, False), (False, False), (False, False)), reservoir_voxels: int = 0, rank: int = 0, pad: tuple[int, ...] = (1, 1, 1), verlet_domains: tuple[int, ...] = (1, 1, 1), return_subdomain: bool = False) → Subdomain | PaddedSubdomain | VerletSubdomain

Initialize PMMoTo domain and subdomain classes and check for valid inputs.

Subpackages