Struct CMapBuilder

pub struct CMapBuilder<const D: usize, T>
where
    T: CoordsFloat,
{ /* private fields */ }

Combinatorial map builder structure

Example

use honeycomb_core::cmap::{CMap2, CMap3, CMapBuilder};

let builder_2d = CMapBuilder::<2, _>::from_n_darts(10);
let map_2d: CMap2<f64> = builder_2d.build()?;
assert_eq!(map_2d.n_darts(), 11); // 10 + null dart = 11

let builder_3d = CMapBuilder::<3, _>::from_n_darts(10);
let map_3d: CMap3<f64> = builder_3d.build()?;
assert_eq!(map_3d.n_darts(), 11); // 10 + null dart = 11

Implementations

impl<const D: usize, T: CoordsFloat> CMapBuilder<D, T>

Regular methods

pub fn from_n_darts(n_darts: usize) -> Self

Create a builder structure for a map with a set number of darts.

pub fn from_grid_descriptor(grid_descriptor: GridDescriptor<D, T>) -> Self

Create a builder structure from a GridDescriptor.

pub fn from_cmap_file(file_path: impl AsRef<Path> + Debug) -> Self

Create a builder structure from a cmap file.

Panics

This function may panic if the file cannot be loaded, or basic section parsing fails.

pub fn from_vtk_file(file_path: impl AsRef<Path> + Debug) -> Self

Create a builder structure from a VTK file.

Panics

This function may panic if the file cannot be loaded.

pub fn add_attribute<A: AttributeBind + 'static>(self) -> Self

Add the attribute A to the attributes the created map will contain.

Usage

Each attribute must be uniquely typed, i.e. a single type or struct cannot be added twice to the builder / map. This includes type aliases as these are not distinct from the compiler’s perspective.

If you have multiple attributes that are represented using the same data type, you may want to look into the Newtype pattern here and here

pub fn build(self) -> Result<<Self as Builder>::MapType, BuilderError>

where Self: Builder,

Consumes the builder and produce a combinatorial map object.

Return / Errors

This method return a Result taking the following values:

• Ok(map: _) if generation was successful,
• Err(BuilderError) otherwise. See BuilderError for possible failures.

Depending on the dimension D associated with this structure, the map will either be a CMap2 or CMap3. If D isn’t 2 or 3, this method will not be available as it uses a trait not implemented for other values of D. This is necessary to handle the multiple return types as Rust is slightly lacking in terms of comptime capabilities.

Panics

This method may panic if type casting goes wrong during parameters parsing.

impl<T: CoordsFloat> CMapBuilder<2, T>

2D pre-definite structures

pub fn unit_grid(n_square: usize) -> Self

Create a CMapBuilder with a predefinite GridDescriptor value.

Arguments

• n_square: usize – Number of cells along each axis.

Return

This function return a builder structure with pre-definite parameters set to generate a specific map.

The map generated by this pre-definite value corresponds to an orthogonal mesh, with an equal number of cells along each axis:

pub fn unit_triangles(n_square: usize) -> Self

Create a CMapBuilder with a predefinite GridDescriptor value.

Arguments

• n_square: usize – Number of cells along each axis.

Return

This function return a builder structure with pre-definite parameters set to generate a specific map.

The map generated by this pre-definite value corresponds to an orthogonal mesh, with an equal number of cells along each axis. Each cell will be split across their diagonal (top left to bottom right) to form triangles:

impl<T: CoordsFloat> CMapBuilder<3, T>

3D pre-definite structures

pub fn hex_grid(n_cells_per_axis: usize, cell_length: T) -> Self

Create a CMapBuilder with a predefinite GridDescriptor value.

Arguments

• n_cells_per_axis: usize – Number of cells along each axis.

Return

The map generated by this pre-definite value corresponds to an orthogonal mesh, with an equal number of cells along each axis:

TODO: add a figure

pub fn tet_grid(n_cells_per_axis: usize, cell_length: T) -> Self

UNIMPLEMENTED