Struct FieldProbe 

pub struct FieldProbe { /* private fields */ }

Records the interpolated field vector (E [V/m] or H [A/m]) at the sample points of a FieldSampler every step: E after the E update at (n + 1)·dt, H after the H update at (n + ½)·dt.

Values and interpolation are those of the dumps (dump module docs); with a one-point DumpRegion this is a field point probe. With several points the recorded vector is their mean (new) or a weighted sum (at).

Implementations

impl FieldProbe

pub fn new(sampler: FieldSampler) -> Self

Probe of sampler’s quantity (the mean over its points).

pub fn at(grid: &Grid, quantity: DumpQuantity, p: [f64; 3]) -> Result<Self>

Probe of quantity at the arbitrary point p [m]: the node-interpolated field (DumpPosition::Nodes) of the up to 2 × 2 × 2 nodes around p, combined trilinearly with the coordinates of p inside its cell. On a mesh line (within 1e-9 of the local cell size) only that line’s nodes are used, so a point on a node is exactly that node’s value.

Errors

Error::Invalid if p is not finite or lies outside the grid.

pub fn sampler(&self) -> &FieldSampler

The sampler.

pub fn times(&self) -> &[f64]

Sample times [s].

pub fn values(&self) -> &[[f64; 3]]

Sampled vectors, parallel to times.

Trait Implementations

impl Clone for FieldProbe

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FieldProbe

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Operator for FieldProbe

fn hooks(&self) -> Hooks

The serial hooks this operator implements (default Hooks::ALL). Queried once, at registration; undeclared hooks are never called. Declaring fewer hooks only saves time: an operator whose hooks are all empty may return Hooks::NONE.

fn post_h(&mut self, fields: &mut Fields<'_>, ctx: &StepContext<'_>)

After the H update (i is at ctx.h_time()).

fn post_e(&mut self, fields: &mut Fields<'_>, ctx: &StepContext<'_>)

After the E update (u is at ctx.e_time()).

fn pre_h(&mut self, _fields: &mut Fields<'_>, _ctx: &StepContext<'_>)

Before the H update of step ctx.step.

fn pre_e(&mut self, _fields: &mut Fields<'_>, _ctx: &StepContext<'_>)

Before the E update.

fn slab_hooks( &mut self, _partition: &SlabPartition<'_>, ) -> Option<Arc<dyn SlabHooks>>

Slab-parallel work for the engine’s x-slab partition (default none). Called once, at registration; the returned object is run by the worker threads (see SlabHooks). The operator may keep a clone of the Arc to read results back.

fn energy(&self) -> f64

Energy [J] held in the operator’s own state at t = n·dt, the time of the E voltages after n completed steps (default 0).