mufem.ProbeReport

class mufem.ProbeReport

Bases: ReportTrait

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

__init__(self: mufem.ProbeReport, name: str, probe: Probe, cff_name: str) → None

Creates a ProbeReport with the given properties.

Args:: name (str): Name of the report. probe (Probe): Probe object. cff_name (str): Name of the CFF.

Methods

`SinglePoint`(name, cff_name, x, y, z)	Creates a ProbeReport for a single point with given properties.
`__init__`(self, name, probe, cff_name)	Creates a ProbeReport with the given properties.
`evaluate`(self)	Returns the value of the report.
`get_name`(self)	Gets the name of the report.

static SinglePoint(name: str, cff_name: str, x: float, y: float, z: float) → mufem.ProbeReport

Creates a ProbeReport for a single point with given properties.

Args:: name (str): Name of the report. cff_name (str): Name of the CFF. x (float): X coordinate of the probe. y (float): Y coordinate of the probe. z (float): Z coordinate of the probe.

evaluate(self: mufem.ProbeReport) → Value

Returns the value of the report.

get_name(self: mufem.ProbeReport) → str

Gets the name of the report.