volumential

Volumential computes 2D and 3D volume potentials using the fast multipole method.

This module is the package entry point. It owns

• the re-exported top-level names listed in __all__ (NearFieldInteractionTable, NearFieldInteractionTableManager and box_quad()),

• the package version string volumential_version,

• the persistent code_cache used by generated loopy kernels, and

• the process-wide optimization and caching switches (OPT_ENABLED, CACHING_ENABLED, set_optimization_enabled(), set_caching_enabled() and CacheMode).

Everything else lives in the submodules; see the documentation’s module map.

volumential.volumential_version = '2017.1a0'

The package version as a string, i.e. volumential.version.VERSION_TEXT.

volumential.code_cache = WriteOncePersistentDict(/home/runner/.cache/pytools/pdict-v5-volumential-code-cache-v0-2017.1a0-3.12.14.final.0.sqlite, nitems=0)

Persistent cache for the generated loopy kernels, keyed by the package version and the kernel revision.

volumential.OPT_ENABLED = True

Whether generated loopy kernels are optimized. Set from the VOLUMENTIAL_NO_OPT environment variable at import time; change it through set_optimization_enabled().

volumential.set_optimization_enabled(flag: bool) → None

Set whether the loopy kernels should be optimized.

volumential.CACHING_ENABLED = True

Whether loopy may use its disk caches. Set from the VOLUMENTIAL_NO_CACHE and CG_NO_CACHE environment variables at import time; change it through set_caching_enabled() or the CacheMode context manager.

volumential.set_caching_enabled(flag: bool) → None

Set whether loopy is allowed to use disk caching for its various code generation stages.

class volumential.CacheMode(new_flag: bool)

Bases: object

A context manager for setting whether volumential is allowed to use disk caches.

Modules

box_operators	Box-local (box-specific) maps, reductions and modal filters.
expansion_wrangler_fpnd	Compatibility shim for the fpnd expansion wranglers.
expansion_wrangler_interface	The stage-by-stage contract every volumential wrangler implements.
expression_eval	Pointwise evaluation of symbolic scalar fields on the device.
function_extension	Function extension with regularity constraints.
gaussian	Gaussian source fixtures and exports for free-space volume-potential demos.
geometry	Geometry construction for volume FMM evaluations.
interpolation	Interpolation between box meshes and meshmode discretizations.
kernel_cache	Disk-cached loopy kernel generation.
lagrange	Stable Lagrange basis evaluation helpers.
list1	List 1 (near-field) potential evaluation from CSR tree data.
list1_gallery	Enumeration of the list 1 (near-neighbor) interaction gallery.
list1_symmetry	Symmetry bookkeeping for the list 1 interaction gallery.
meshgen	Box mesh generation on top of the boxtree tree-of-boxes interface.
nearfield_potential_table
opcounters	Explicit operation counters for the measurement drivers kept with the manuscripts (experiment E3).
orbit_arithmetic	Arithmetic ORBIT addressing for near-field interaction tables.
phase_profile	Per-phase wall-clock profiling for the measurement drivers kept with the manuscripts (experiment E6).
rke_table_assembly	Certified RKE assembly of fixed-parameter near-field tables.
singular_integral_2d	The 2D singular integrals are computed using the transform described in http://link.springer.com/10.1007/BF00370482.
symbolic	Symbolic (pymbolic) building blocks for analytic fields.
table_manager	Near-field interaction tables and the manager that owns them.
tools	Miscellaneous host-side utilities, plus the historical grab-bag import surface.
tree_interactive_build	Interactive box-tree construction for adaptive volume FMM meshes.
version	Version and kernel-revision metadata for volumential.
volume_fmm	Drive the volume FMM and interpolate its output.
wranglers	Expansion wranglers implementing the fpnd strategy.