Struct cpo_analyzer::configuration::pole_figure_configuration::PoleFiguresConfiguration

pub struct PoleFiguresConfiguration {
    pub time_data_file: String,
    pub particle_data_file_prefix: String,
    pub grain_data_file_prefix: String,
    pub figure_output_dir: String,
    pub figure_output_prefix: String,
    pub color_scale: ColorGradient,
    pub elastisity_header: bool,
    pub small_figure: bool,
    pub no_description_text: bool,
    pub times: Vec<f64>,
    pub particle_ids: Vec<usize>,
    pub axes: Vec<CrystalAxes>,
    pub minerals: Vec<Mineral>,
}

The configuration of the pole figure analysis.

Fields

time_data_file: String

Optional value where to find the data file relating the numbers of the individual data files with the time they represent. The default value is statistics.

particle_data_file_prefix: String

Optional value of the prefix where to find the data file containing global particle data per timestep such as the particle id, position, deformation type and elasticity information. The program will add a postfixes containing time and mpi process information in the format of -00000.0000.dat in which the first 5 zero's represent the timestep and the last 4 zero's represent the different files for that timestep. For each timestep, the program will automatically search through all files of the same timestep untill it find the file containing the particle id it was looking for. The program assumes that all the particles of the same id are not spread out over sever files, but stored in one file. Having multiple particle id's per file is fine. The default value is particle_CPO/particles.

grain_data_file_prefix: String

Optional value of the prefix where to find the data file containing grain data per timestep. This is the particle id and euler angles of the olivine and enstatite. The program will add a postfixes containing time and mpi process information in the format of -00000.0000.dat in which the first 5 zero's represent the timestep and the last 4 zero's represent the different files for that timestep. For each timestep, the program will automatically search through all files of the same timestep untill it find the file containing the particle id it was looking for. The program assumes that all the particles of the same id are not spread out over sever files, but stored in one file. Having multiple particle id's per file is fine. The default value is particle_CPO/weighted_CPO.

figure_output_dir: String

Optional value of the prefix where to write out the produced pole figures. The program will add a postfix containing informatio about individual variables and settings such as the timestep and axes, etc. The default value is CPO_figures/.

figure_output_prefix: String

Optional value of the prefix where to write out the produced pole figures. The program will add a postfix containing informatio about individual variables and settings such as the timestep and axes, etc. The default value is weighted_LPO.

color_scale: ColorGradient

Optional value of the color gradient. Available options are Vik, Batlow, Simple, Imola, Hawaii and Roma, which are all, except for Simple, from http://www.fabiocrameri.ch/colourmaps.php. The default value is Batlow.

elastisity_header: bool

Optional value whether to inluce elasticity information in the header of the polefigure. Default is true.

small_figure: bool

Optional value whether to create a small (500x500 per pole figure) or normal (800x800 per pole figure) figure size. Default is false.

no_description_text: bool

Optional value whether to omit mineral and axis information to the figure. Default value is false.

times: Vec<f64>

A vector containing the times at which to make the pole figures. The acutal times are set to the closest time for which data is available.

particle_ids: Vec<usize>

A vector containing the id's of the particles to plot. A plot for is made for every id.

axes: Vec<CrystalAxes>

A vector of the crytal axis to plot. This will be plot on the horizontal axis of the plot, and the maximum of the maximum count of the pole figures will be used as the new maximum to scale the colors. Available options are AAxis, BAxis and CAxis.

minerals: Vec<Mineral>

A vector containing the minerals to be plot. These will be added as a vertical axis to the plot. Available options are Olivine and Enstatite.

Trait Implementations

impl Clone for PoleFiguresConfiguration

fn clone(&self) -> PoleFiguresConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for PoleFiguresConfiguration

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for PoleFiguresConfiguration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.