sssf 0.1.0

Super simple simulation framework.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

use std::fs::File;
use std::io::Write;
use std::path::{PathBuf};

pub trait ToCSV {
    fn get_header() -> String;
    fn get_row(&self) -> String;
}

pub struct SimManger<DynamicParameters, EnvironmentParameters, StepFn>
where
    StepFn: FnMut(&DynamicParameters, &mut EnvironmentParameters) -> DynamicParameters,
{
    /// parameters that change while simulation is running and that we want to keep track of, eg. particle's position
    pub(crate) parameters: Vec<DynamicParameters>,
    /// parameters that are constant throughout whole simulation or those we don't need to track, eg. gravitational constant
    pub(crate) environment_parameters: EnvironmentParameters,
    pub(crate) step_fn: StepFn,
    pub(crate) output_file: Option<PathBuf>,
}

impl<DynamicParameters, EnvironmentParameters, StepFn>
    SimManger<DynamicParameters, EnvironmentParameters, StepFn>
where
    StepFn: FnMut(&DynamicParameters, &mut EnvironmentParameters) -> DynamicParameters,
{
    /// creates new instance of SimManager
    pub fn new(
        initial_conditions: DynamicParameters,
        environment_parameters: EnvironmentParameters,
        step_fn: StepFn,
    ) -> Self {
        SimManger {
            parameters: vec![initial_conditions],
            environment_parameters,
            step_fn,
            output_file: None,
        }
    }

    pub fn run<StopFn>(&mut self, stop_fn: StopFn) -> &mut Self
    where
        StopFn: Fn(&DynamicParameters, &EnvironmentParameters) -> bool,
    {
        loop {
            let new_parameters = (self.step_fn)(
                self.parameters.last().unwrap(),
                &mut self.environment_parameters,
            );
            self.parameters.push(new_parameters);

            if stop_fn(
                self.parameters.last().unwrap(),
                &self.environment_parameters,
            ) {
                break;
            }
        }
        self
    }
}

impl<DynamicParameters, EnvironmentParameters, StepFn>
    SimManger<DynamicParameters, EnvironmentParameters, StepFn>
where
    DynamicParameters: ToCSV,
    StepFn: FnMut(&DynamicParameters, &mut EnvironmentParameters) -> DynamicParameters,
{
    pub fn to_file<'a>(&'a mut self, path: PathBuf) -> &'a mut Self {
        self.output_file = Some(path);
        self
    }

    pub fn run_with_save<StopFn>(&mut self, stop_fn: StopFn) -> &mut Self
    where
        StopFn: Fn(&DynamicParameters, &EnvironmentParameters) -> bool,
    {
        self.run(stop_fn);
        self.output_to_file();
        self
    }

    fn output_to_file(&self) {
        let path = self.output_file.as_ref().expect("You need to provide output file path first");
        let mut file = File::create(
            path
        )
        .expect("Cannot create file");

        file.write(format!("{}\n", DynamicParameters::get_header()).as_bytes()).unwrap();
        self.parameters
            .iter()
            .for_each(|x| {
                file.write(format!("{}\n", x.get_row()).as_bytes()).unwrap();
            } );
    }
}