Struct ConcatPostPrcess

pub struct ConcatPostPrcess {
    dataset: Vec<PostProcess>,
}

Fields

dataset: Vec<PostProcess>

Implementations

impl ConcatPostPrcess

pub fn new(folder: &[&str], root: Option<String>) -> Result<Self, ApiError>

pub fn get_time_end(&self) -> Result<Vec<f64>, String>

Retrieves the last time value from each dataset in the collection.

Returns

• Result<Vec<f64>, String> - A vector of the last time values for each dataset or an error message if any dataset is empty.

Trait Implementations

impl Debug for ConcatPostPrcess

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

Formats the value using the given formatter.

impl PostProcessReader for ConcatPostPrcess

fn time_array(&self) -> Array1<f64>

Concatenates the time arrays from all datasets into a single array view.

Returns

• ArrayView1<f64> - A concatenated array view of time data.

fn time(&self) -> &[f64]

Returns a reference to the time data from the simulation results.

fn v_liquid(&self) -> ArrayView2<'_, f64>

fn get_spatial_average_property( &self, key: &str, ) -> Result<Array2<f64>, ApiError>

fn get_concentrations(&self, phase: Phase) -> ArrayView3<'_, f64>

fn get_variance_concentration( &self, species: usize, phase: Phase, ) -> Result<Array1<f64>, ApiError>

fn get_spatial_average_biomass_concentration( &self, ) -> Result<Array1<f64>, ApiError>

fn get_probes(&self) -> Result<Array1<f64>, ApiError>

fn get_property_names(&self) -> Vec<String>

Returns model’s property names

fn get_max_n_export_bio(&self) -> usize

Retrieves the maximum number of biological export events.

fn n_export(&self) -> usize

Retrieves the total number of export events from the simulation results.

fn get_spatial_average_concentration( &self, species: usize, phase: Phase, ) -> Array1<f64>

Computes the spatial average concentration for a specific species and phase.

fn get_time_average_concentration( &self, species: usize, position: usize, phase: Phase, ) -> Result<Array1<f64>, ApiError>

Computes the time average concentration for a specific species, position, and phase.

fn get_spatial_average_mtr( &self, species: usize, ) -> Result<Array1<f64>, ApiError>

fn get_biomass_concentration(&self) -> Result<Array2<f64>, ApiError>

Calculates the biomass concentration over time.

fn get_growth_in_number(&self) -> Array1<f64>

Calculates the total growth in number.

fn weight(&self) -> &Weight

Returns a weight chosen for simulation

fn get_number_particle(&self) -> &Array2<f64>

Retrieves a reference to the 2D array of particle numbers.

fn get_properties( &self, key: &str, i_export: usize, ) -> Result<Array1<f64>, ApiError>

Fetches specific properties of the model at a given export index.

fn get_time_population_mean(&self, key: &str) -> Result<Array1<f64>, ApiError>

Calculates the time-averaged population mean for a specific property key.

fn get_histogram_array( &self, n_bins: usize, i_export: usize, key: &str, ) -> Result<(Array1<f64>, Array1<f64>), ApiError>

Retrieves histogram data for a specific property key at a given export index.

fn get_histogram( &self, n_bins: usize, i_export: usize, key: &str, ) -> Result<(Vec<f64>, Vec<f64>), ApiError>

Retrieves histogram data for a specific property key at a given export index.

fn get_population_mean( &self, key: &str, i_export: usize, ) -> Result<f64, ApiError>

Retrieves the population mean for a specific property key at a given export index.

fn tallies(&self) -> Option<&Tallies>

Returns