Struct CMModel 

pub struct CMModel {
    geometry: Arc<CMGeometry>,
    c_info: CompartmentInfo,
    interfaces: AInterfacesInfo,
}

Fields

geometry: Arc<CMGeometry>

c_info: CompartmentInfo

interfaces: AInterfacesInfo

Implementations

impl CMModel

fn check_flux(n_zone: u32, rf: &RawFlux) -> bool

Both directions must carry a usable flow and both ids must address a compartment, check_flow indexes mass_balance with them right after

pub fn check_flow( &self, raw: &RawDataFlux, max_divergence: f64, ) -> Result<(), ModelError>

impl CMModel

pub fn grid(&self) -> &dyn CompartmentMesh

pub fn init(geometry: Arc<CMGeometry>) -> Self

fn compute_volume_integral_per_zone() -> Vec<f64>

fn normal_velocity( &self, vector: &Vector, element_global_id: usize, axis: usize, ) -> f64

Velocity of one element along the normal of the interface it crosses.

The velocity stays a vector up to here and is projected on the local normal: on a radial or theta face the normal turns with theta, so it has to be taken at the position of the element and not once for the whole interface.

pub fn compute_flux_between_compartments( &self, vector: Vector, settings: &BalanceSettings, ) -> Result<RawDataFlux, CoreError>

fn balance( &self, flows: &mut [InterfaceFlow], settings: &BalanceSettings, ) -> BalanceReport

Balance flow

A flow is only ever multiplied by a positive factor. Scaling the flows leaving a compartment by sqrt(in / out) moves it halfway to its balance, and repeating it converges the same way Sinkhorn balancing does.

pub fn export_volume_integral_per_zone( &self, model_scalar: Scalar, ) -> Result<RawDataScalar, CoreError>

pub fn compartments_volumes(&self) -> Vec<f64>

pub fn get_real_volume(&self) -> Vec<f64>