Struct Writer 

pub struct Writer {
    pub outputs: Vec<Output>,
    pub output_counter: usize,
    pub should_perform_output: bool,
    pub meta_data: String,
    pub print_banner: bool,
}

The struct responsible for handling writing simulation data to output streams.

Refer to CorriesConfig and OutputConfig for how to configure it and what your options are.

Fields

outputs: Vec<Output>

Contains the objects that handle writing into single streams.

output_counter: usize

Current output counter

should_perform_output: bool

Whether we should perform an output at this point

meta_data: String

The stringified simulation config

print_banner: bool

Whether to print the banner

Implementations

impl Writer

pub fn new<const S: usize>( config: &CorriesConfig, mesh: &Mesh<S>, ) -> Result<Self>

Builds a new color_eyre::Result<Writer> object.

Arguments

• config - Configuration for a corries simulation
• mesh - The mesh for this simulation

pub fn update_data( &mut self, u: &impl Collectable, time: &impl Collectable, mesh: &impl Collectable, ) -> Result<()>

Loops through self.outputs and calls their update_data_matrix methods.

Arguments

• u - Provides data for the state of the simulation
• time - Provides data on the time coordinates
• mesh - Provides mesh data

pub fn write_output(&mut self) -> Result<()>

Writes to all defined output streams

pub fn write_metadata<const S: usize>(&mut self) -> Result<()>

Writes metadata to all output streams

Trait Implementations

impl Clone for Writer

fn clone(&self) -> Writer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Writer

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

Formats the value using the given formatter.

impl Default for Writer

fn default() -> Writer

Returns the “default value” for a type.

impl Send for Writer

impl Sync for Writer