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: StringUnique name for this EMC
version: StringVersion string
equation: StringThe governing equation in LaTeX
class: EquationClassEquation classification
citation: CitationPrimary 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: StringDescription/abstract
lineage: Vec<String>Parent EMCs this derives from
Implementations§
Source§impl EquationModelCard
impl EquationModelCard
Sourcepub fn builder() -> EmcBuilder
pub fn builder() -> EmcBuilder
Create a new EMC builder.
Sourcepub fn from_equation<E: GoverningEquation>(equation: &E) -> EmcBuilder
pub fn from_equation<E: GoverningEquation>(equation: &E) -> EmcBuilder
Create an EMC from a GoverningEquation implementation.
Trait Implementations§
Source§impl Clone for EquationModelCard
impl Clone for EquationModelCard
Source§fn clone(&self) -> EquationModelCard
fn clone(&self) -> EquationModelCard
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for EquationModelCard
impl RefUnwindSafe for EquationModelCard
impl Send for EquationModelCard
impl Sync for EquationModelCard
impl Unpin for EquationModelCard
impl UnsafeUnpin for EquationModelCard
impl UnwindSafe for EquationModelCard
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more