Enum GaussOrder 

pub enum GaussOrder {
    G2,
    G3,
    G4,
    G5,
    G8,
}

Node count of a fixed-order Gauss-Legendre rule.

A closed set rather than an open usize, so the choice is exhaustive at every match site and rust-analyzer lists the options on hover — and so the nodes can be validated once per order rather than for whatever number a caller happens to pass.

An n-point Gauss-Legendre rule integrates any polynomial of degree 2n - 1 or less exactly (to rounding), which is both the reason to prefer it over Simpson at equal cost and the property the tests use as their oracle.

Order	Nodes	Exact to degree
G2	2	3
G3	3	5
G4	4	7
G5	5	9
G8	8	15

Units

Dimensionless — a mode selector.

Variants

G2

Two-point rule, exact to cubics.

G3

Three-point rule, exact to quintics.

G4

Four-point rule, exact to degree 7.

G5

Five-point rule, exact to degree 9.

G8

Eight-point rule, exact to degree 15.

Implementations

impl GaussOrder

pub const fn points(self) -> usize

Number of nodes in the rule, dimensionless.

pub const fn exact_degree(self) -> usize

The highest polynomial degree this rule integrates exactly, 2n - 1.

Example

use outram_foam_basic_lib::ode::parallel::GaussOrder;

assert_eq!(GaussOrder::G5.points(), 5);
assert_eq!(GaussOrder::G5.exact_degree(), 9);

Trait Implementations

impl Clone for GaussOrder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for GaussOrder

impl Debug for GaussOrder

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

Formats the value using the given formatter.

impl Default for GaussOrder

fn default() -> Self

Returns the “default value” for a type.

impl Eq for GaussOrder

impl Hash for GaussOrder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for GaussOrder

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GaussOrder