Struct Checkpoint 

pub struct Checkpoint<const N: usize> { /* private fields */ }

Represents a snapshot of a Mesh along with relavent field data.

The Checkpoint<N> can then be serialized and deserialized from disk, allowing data to be loaded/reused across runs.

Implementations

impl<const N: usize> Checkpoint<N>

pub fn attach_mesh(&mut self, mesh: &Mesh<N>)

Attaches a mesh to the checkpoint

pub fn set_embedding<const S: usize>(&mut self, positions: &[[f64; S]])

Sets the mesh as embedded in a higher dimensional space.

pub fn read_mesh(&self) -> Mesh<N>

Clones the mesh attached to the checkpoint.

pub fn save_image(&mut self, name: &str, data: ImageRef<'_>)

Saves image data with the given name key.

pub fn read_image(&self, name: &str) -> Image

Reads image data associated to the given name.

pub fn save_field(&mut self, name: &str, data: &[f64])

Attaches a field for serialization in the model.

pub fn load_field(&self, name: &str, data: &mut Vec<f64>)

Reads a field from the model.

pub fn read_field(&self, name: &str) -> Vec<f64>

Reads a field from the model.

pub fn save_int_field(&mut self, name: &str, data: &[i64])

Attaches an integer field for serialization in the checkpoint.

pub fn load_int_field(&self, name: &str, data: &mut Vec<i64>)

Reads an integer field from the checkpoint.

pub fn save_meta(&mut self, name: &str, data: &str)

Saves meta data associated with a given string.

pub fn load_meta(&self, name: &str, data: &mut String)

Loads meta data associated with a given string into data

pub fn write_meta<T: ToString>(&mut self, name: &str, data: T)

Writes meta data associated with a given type to the checkpoint.

pub fn read_meta<T: FromStr>( &self, name: &str, ) -> Result<T, CheckpointParseError>

Reads meta data associated with a given type from the checkpoint.

pub fn import_dat(path: impl AsRef<Path>) -> Result<Self>

Loads the mesh and any additional data from disk.

pub fn export_dat(&self, path: impl AsRef<Path>) -> Result<()>

Saves the checkpoint as a dat file at the given path.

impl<const N: usize> Checkpoint<N>

pub fn export_csv( &self, path: impl AsRef<Path>, stride: ExportStride, ) -> Result<()>

pub fn export_vtu( &self, path: impl AsRef<Path>, config: ExportVtuConfig, ) -> Result<()>

Checkpoint and additional field data to a .vtu file, for visualisation in applications like Paraview. This requires a mesh be attached to the checkpoint.

Trait Implementations

impl<const N: usize> Clone for Checkpoint<N>

fn clone(&self) -> Checkpoint<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for Checkpoint<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for Checkpoint<N>

fn default() -> Checkpoint<N>

Returns the “default value” for a type.

impl<'de, const N: usize> Deserialize<'de> for Checkpoint<N>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize> Serialize for Checkpoint<N>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.