Struct MultiDomainState 

pub struct MultiDomainState { /* private fields */ }

Multi-domain physical state container.

Maps (DomainId, PhysicalQuantity) composite keys to ContextValue fields. Used by CouplingOperator to exchange state between physical domains without implicit ordering conventions (DD-010, DD-011, INV-3).

Examples

use oxiflow::context::state::MultiDomainState;
use oxiflow::context::quantity::PhysicalQuantity;
use oxiflow::context::value::ContextValue;
use oxiflow::solver::scenario::DomainId;
use nalgebra::DVector;

let mut state = MultiDomainState::new();

state.set(
    DomainId::new("column"),
    PhysicalQuantity::concentration(),
    ContextValue::ScalarField(DVector::from_vec(vec![0.0, 1.0, 2.0])),
);

let field = state.get(&DomainId::new("column"), &PhysicalQuantity::concentration());
assert!(field.is_some());

Implementations

impl MultiDomainState

pub fn new() -> Self

Creates an empty state container.

pub fn get( &self, domain: &DomainId, quantity: &PhysicalQuantity, ) -> Option<&ContextValue>

Returns a reference to the field for (domain, quantity), if present.

pub fn get_mut( &mut self, domain: &DomainId, quantity: &PhysicalQuantity, ) -> Option<&mut ContextValue>

Returns a mutable reference to the field for (domain, quantity), if present.

pub fn set( &mut self, domain: DomainId, quantity: PhysicalQuantity, value: ContextValue, )

Inserts or replaces the field for (domain, quantity).

pub fn remove( &mut self, domain: &DomainId, quantity: &PhysicalQuantity, ) -> Option<ContextValue>

Removes the field for (domain, quantity), returning it if present.

pub fn is_empty(&self) -> bool

Returns true if no fields are stored.

pub fn len(&self) -> usize

Returns the number of stored fields.

pub fn iter( &self, ) -> impl Iterator<Item = (&DomainId, &PhysicalQuantity, &ContextValue)>

Returns an iterator over all ((domain, quantity), value) entries.

pub fn domain_fields<'a>( &'a self, domain: &'a DomainId, ) -> impl Iterator<Item = (&'a PhysicalQuantity, &'a ContextValue)> + 'a

Returns all fields belonging to domain.

pub fn contains_domain(&self, domain: &DomainId) -> bool

Returns true if domain has at least one field stored.

pub fn validate_domain_consistency( &self, domain: &DomainId, ) -> Result<(), OxiflowError>

Verifies that all fields for a domain have the same number of DOFs.

Returns OxiflowError::InvalidDomain if inconsistent field lengths are detected for domain.

Trait Implementations

impl Clone for MultiDomainState

fn clone(&self) -> MultiDomainState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MultiDomainState

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

Formats the value using the given formatter.

impl Default for MultiDomainState

fn default() -> Self

Returns the “default value” for a type.