Skip to main content

EquationModelCard

Struct EquationModelCard 

Source
pub struct EquationModelCard {
Show 13 fields pub name: String, pub version: String, pub equation: String, pub class: EquationClass, pub citation: Citation, pub references: Vec<Citation>, pub variables: Vec<EquationVariable>, pub verification_tests: Vec<VerificationTest>, pub domain_constraints: Vec<DomainConstraint>, pub falsification_criteria: Vec<FalsificationCriterion>, pub implementation_notes: Vec<ImplementationNote>, pub description: String, pub lineage: Vec<String>,
}
Expand description

Equation Model Card - Complete documentation for a governing equation.

An EMC must be attached to any simulation using the equation. It provides:

  • Traceability to peer-reviewed literature
  • Verification test cases from analytical solutions
  • Domain constraints for valid operation
  • Falsification criteria for scientific validity

Fields§

§name: String

Unique name for this EMC

§version: String

Version string

§equation: String

The governing equation in LaTeX

§class: EquationClass

Equation classification

§citation: Citation

Primary citation

§references: Vec<Citation>

Additional references

§variables: Vec<EquationVariable>

Variables in the equation

§verification_tests: Vec<VerificationTest>

Verification tests

§domain_constraints: Vec<DomainConstraint>

Domain constraints

§falsification_criteria: Vec<FalsificationCriterion>

Falsification criteria

§implementation_notes: Vec<ImplementationNote>

Implementation notes

§description: String

Description/abstract

§lineage: Vec<String>

Parent EMCs this derives from

Implementations§

Source§

impl EquationModelCard

Source

pub fn builder() -> EmcBuilder

Create a new EMC builder.

Source

pub fn from_equation<E: GoverningEquation>(equation: &E) -> EmcBuilder

Create an EMC from a GoverningEquation implementation.

Source

pub fn run_verification_tests<F>( &self, evaluator: F, ) -> Vec<(String, bool, String)>
where F: Fn(&HashMap<String, f64>) -> f64,

Run all verification tests.

Returns a list of (test_name, passed, message) tuples.

Source

pub fn verify<F>(&self, evaluator: F) -> Result<(), Vec<String>>
where F: Fn(&HashMap<String, f64>) -> f64,

Check if all verification tests pass.

§Errors

Returns a list of failure messages if any verification tests fail.

Trait Implementations§

Source§

impl Clone for EquationModelCard

Source§

fn clone(&self) -> EquationModelCard

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EquationModelCard

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V