Model

muse2::model

Struct Model 

Source 
pub struct Model {
    pub model_path: PathBuf,
    pub parameters: ModelParameters,
    pub agents: AgentMap,
    pub commodities: CommodityMap,
    pub processes: ProcessMap,
    pub time_slice_info: TimeSliceInfo,
    pub regions: RegionMap,
    pub investment_order: HashMap<u32, Vec<InvestmentSet>>,
}
Expand description

Model definition

Fields§

§model_path: PathBuf

Path to model folder

§parameters: ModelParameters

Parameters from the model TOML file

§agents: AgentMap

Agents for the simulation

§commodities: CommodityMap

Commodities for the simulation

§processes: ProcessMap

Processes for the simulation

§time_slice_info: TimeSliceInfo

Information about seasons and time slices

§regions: RegionMap

Regions for the simulation

§investment_order: HashMap<u32, Vec<InvestmentSet>>

Commodity ordering for each milestone year

Implementations§

Source§

impl Model

Source

pub fn iter_years(&self) -> impl Iterator<Item = u32> + '_

Iterate over the model’s milestone years.

Source

pub fn iter_regions(&self) -> Keys<'_, RegionID, Region>

Iterate over the model’s regions (region IDs).

Source

pub fn iter_markets(&self) -> impl Iterator<Item = (CommodityID, RegionID)> + '_

Iterate over all the markets in the model.

Auto Trait Implementations§

§

impl Freeze for Model

§

impl RefUnwindSafe for Model

§

impl !Send for Model

§

impl !Sync for Model

§

impl Unpin for Model

§

impl UnwindSafe for Model

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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.