Struct rustencils::grid::CartesianGridSpec

pub struct CartesianGridSpec { /* fields omitted */ }

The CartesianGridSpec struct represents the specifications of a Grid in Cartesian coordinates. The dimensionality can be any size, which means it could be more or less than the standard 3-dimensional Cartesian coordinate space.

Implementations

impl CartesianGridSpec

pub fn new(axes: Vec<AxisSetup>) -> Self

Returns a CartesianGridSpec built from a vector of AxisSetup structs.

Arguments

• axes - vector containing one or more instances of AxisSetup (Vec)

Examples

use rustencils::grid::{AxisSetup, GridSpec, CartesianGridSpec};
let x = AxisSetup::new(0., 0.01, 100);
let y = x.clone();
let axs = vec![x, y];
let spec = CartesianGridSpec::new(axs);
assert_eq!(spec.get_gridshape(), &vec![100,100]);
assert_eq!(spec.get_spacing(), &vec![0.01,0.01]);

Trait Implementations

impl Debug for CartesianGridSpec

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

Formats the value using the given formatter.

impl GridSpec for CartesianGridSpec

fn get_coords(&self) -> &Vec<Vec<f64>>

Returns a shared reference to the vector containing the sets of points along the coordinate axes that make up the grid (e.g., [[x0,x1,x2,…,xm],[y0,y1,y2,…,yn]]).

fn get_ndim(&self) -> usize

Returns a usize that represents the dimensionality of the grid.

fn get_gridshape(&self) -> &Vec<usize>

Returns a shared reference to a vector that contains the number of points along each axis (e.g., [m,n]).

fn get_spacing(&self) -> &Vec<f64>

Returns a shared reference to a vector that contains the spacing between the points on the coordinate axes (e.g., [(x1-x0),(y1-y0)]).

fn get_grid(&self) -> &Grid

Returns a shared reference to the Grid instance.

fn get_bound_pts(&self, dimension: usize, side: BoundarySide) -> Vec<Point>

Returns an owned vector of Point structs that represent the boundary points along the specified axis. Here, the boundary points refer to the outermost set of points along the edge of the grid.

fn get_bound_idxs(&self, dimension: usize, side: BoundarySide) -> Vec<usize>

Returns an owned vector of usizes that represent the index values of the boundary points along the specified axis. Here, the boundary points refer to the outermost set of points along the edge of the grid.

impl PartialEq<CartesianGridSpec> for CartesianGridSpec

fn eq(&self, other: &CartesianGridSpec) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CartesianGridSpec) -> bool

This method tests for !=.

impl StructuralPartialEq for CartesianGridSpec