API

Core

mufem.Simulation

Manages domain, runner, materials, reports, and coefficient functions for a μfem simulation.

mufem.ModelManager

Manages all models used in the simulation lifecycle, including initialization, iteration, finalization, and residual tracking.

mufem.CoefficientFunctionManager

Manages scalar, vector, and matrix coefficient functions.

mufem.UnsteadyRunner

Unsteady runner implementing time-stepping simulation.

mufem.SteadyRunner

Steady runner class implementing the steady-state simulation.

mufem.Marker

mufem.Vol

mufem.Bnd

Expressions

The following coefficient expressions are available:

mufem.CffConstantVector(x, y, z)

Creates a three-dimensional vector coefficient with constant components.

mufem.CffVectorComponent(cff_x, cff_y, cff_z)

Creates a vector coefficient from scalar component coefficients.

mufem.CffSinusoidal(amplitude[, frequency, ...])

Creates a sinusoidal scalar coefficient.

mufem.CffConstantScalar(value)

Creates a scalar coefficient that always returns a constant value.

mufem.CffExpressionScalar(expression)

Creates a scalar coefficient from a mathematical expression string.

mufem.CffTimeTable(time, value)

Creates a scalar coefficient from time-value pairs using linear interpolation.

Reports and Monitors

Reports are used to query data from the simulation. They can be used to compute integrals, averages, or extract values at specific points in the mesh. Monitors are used to track changes in the simulation over time.

mufem.ReportManager

Class responsible for managing simulation reports.

mufem.ProbeReport

Probe report that returns the value at a specific location in the domain

mufem.VolumeIntegralReport

mufem.SurfaceIntegralReport

mufem.SurfaceAverageReport

mufem.MinMaxReport

mufem.MonitorManager

Class responsible for managing simulation monitors.

mufem.ReportMonitor

Class representing a monitor for a report.