Struct SimulationSetup

pub struct SimulationSetup<C, D> {
    pub cells: Vec<C>,
    pub domain: D,
}

Available on crate feature chili only.

Struct containing all necessary information to construct a fully working simulation and run it.

Fields

cells: Vec<C>

The initial cells contained in the simulation. In the future we hope to provide an abstract type in order to allow for pure iterators to be stored here

domain: D

The physical simulation domain which is specified by the Domain trait.

Implementations

impl<C, D> SimulationSetup<C, D>

pub fn insert_cells<I>(&mut self, cells: I)

where I: IntoIterator<Item = C>,

Available on crate feature cpu_os_threads only.

Insert more cells into the setup after having already initialized the setup.

pub fn decompose<S>( self, n_subdomains: NonZero<usize>, ) -> Result<DecomposedDomain<<D as Domain<C, S>>::SubDomainIndex, S, C>, DecomposeError>

where D: Domain<C, S>, S: SubDomain,

Available on crate feature cpu_os_threads only.

Decomposes the struct into a DecomposedDomain which can be taken by the backend and turned into multiple subdomains.

pub fn decompose_auto_tune<S>( self, ) -> Result<DecomposedDomain<<D as Domain<C, S>>::SubDomainIndex, S, C>, DecomposeError>

where D: Domain<C, S>, S: SubDomain,

Available on crate feature cpu_os_threads only.

Similar to decompose method but does not require to specify how many subdomains should be chosen. It will attempt to retrieve resources available to the system and spawn threads which are either pre-calculated, read from an existing file or acquired by auto-tuning.

Trait Implementations

impl<C, D> Clone for SimulationSetup<C, D>

where C: Clone, D: Clone,

fn clone(&self) -> SimulationSetup<C, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de, C, D> Deserialize<'de> for SimulationSetup<C, D>

where C: Deserialize<'de>, D: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<SimulationSetup<C, D>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C, D> Serialize for SimulationSetup<C, D>

where C: Serialize, D: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.