Struct CheckOptions 

pub struct CheckOptions {
    pub cells_per_wavelength: f64,
    pub min_cells_per_wavelength: f64,
    pub max_grading: f64,
    pub timestep_ratio: f64,
    pub pml_max_spread: f64,
    pub snap_tolerance: f64,
    pub update_model: bool,
}

Thresholds of the mesh checks.

Fields

cells_per_wavelength: f64

Required cells per local wavelength at f_max (default 20); fewer gives a Severity::Warning.

min_cells_per_wavelength: f64

Below this many cells per wavelength (default 10) the issue is a Severity::Error.

max_grading: f64

Largest allowed neighbour cell size ratio (default 1.5).

timestep_ratio: f64

Warn when dt is below this fraction of the time step the median cells would allow (default 0.2).

pml_max_spread: f64

Warn when the largest and smallest cell inside a PML differ by more than this factor (default 2).

snap_tolerance: f64

Relative tolerance (of the local cell size) for sheets and lines to count as lying on a mesh line (default 1e-6, as the compile step).

update_model: bool

Re-evaluate parametric values on a clone of the model first (default true).

Implementations

impl CheckOptions

pub fn cells_per_wavelength(self, n: f64) -> Self

Sets cells_per_wavelength.

pub fn min_cells_per_wavelength(self, n: f64) -> Self

Sets min_cells_per_wavelength.

pub fn max_grading(self, r: f64) -> Self

Sets max_grading.

pub fn timestep_ratio(self, r: f64) -> Self

Sets timestep_ratio.

pub fn pml_max_spread(self, r: f64) -> Self

Sets pml_max_spread.

Trait Implementations

impl Clone for CheckOptions

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 CheckOptions

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

Formats the value using the given formatter.

impl Default for CheckOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for CheckOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CheckOptions