Struct GridBuilder 

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

Grid builder structure

Generics

• const D: usize – Dimension of the grid. Should be 2 or 3.
• T: CoordsFloat – Generic FP type that will be used by the map’s vertices.

Example

use honeycomb_core::cmap::CMap3;
use honeycomb_kernels::grid_generation::{GridBuilder};

let map: CMap3<f64> = GridBuilder::<3, f64>::default()
    .n_cells([2, 3, 2])
    .len_per_cell([1.0; 3])
    .build()?;

Implementations

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

pub fn n_cells(self, n_cells: [usize; D]) -> Self

Set values for all dimensions

pub fn len_per_cell(self, len_per_cell: [T; D]) -> Self

Set values for all dimensions

pub fn lens(self, lens: [T; D]) -> Self

Set values for all dimensions

pub fn origin(self, origin: [T; D]) -> Self

Set origin (most bottom-left vertex) of the grid

pub fn split_cells(self, split: bool) -> Self

Indicate whether to split cells of the grid

In 2D, this will result in triangular cells.

In 3D, this will result in tetrahedral cells.

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

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

pub fn unit_grid(n_cells_per_axis: usize) -> CMap2<T>

Create a combinatorial map representing a 2D orthogonal grid.

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) -> CMap2<T>

Create a combinatorial map representing a 2D orthogonal grid.

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

pub fn build(self) -> Result<CMap2<T>, GridBuilderError>

Consumes the builder and produce a combinatorial map object.

This method is only available for D == 2 or D == 3.

Return / Errors

This method return a Result taking the following values:

• Ok(map: CMap2<T>) if generation was successful,
• Err(GridBuilderError) otherwise. See GridBuilderError for possible failures.

Panics

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

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

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

Create a combinatorial map representing a 3D orthogonal grid.

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

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

Create a combinatorial map representing a 3D orthogonal grid.

The map generated by this pre-definite value corresponds to an orthogonal mesh, with an equal number of cells along each axis. each hexahedral cell is cut into 5 tetrahedra; this pattern is repeated with added symmetry to produce a conformal mesh:

pub fn build(self) -> Result<CMap3<T>, GridBuilderError>

Consumes the builder and produce a combinatorial map object.

This method is only available for D == 2 or D == 3.

Return / Errors

This method return a Result taking the following values:

• Ok(map: CMap3<T>) if generation was successful,
• Err(GridBuilderError) otherwise. See GridBuilderError for possible failures.

Panics

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

Trait Implementations

impl<const D: usize, T: CoordsFloat> Default for GridBuilder<D, T>

fn default() -> Self

Returns the “default value” for a type.