Module rustencils::grid[][src]

Structs

AxisSetup

For consistency, this AxisSetup struct is used as an argument when constructing GridSpecs. It contains the minimum axis value (start: f64), the spacing of the axis points (delta: f64), and the number of axis points including the start value (steps: usize).

CartesianGridSpec

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.

Grid

The Grid struct represents the physical space over which the PDE is defined.

GridScalar

The GridScalar struct is the type that represents the values of interest. It contains a GridSpec and a ValVector.

Point

The Point struct represents a single point on the Grid. Each Point contains a vector of the axis values at that Point, as well as an index that corresponds to the position within the GridQty that represents the value of interest at that Point.

ValVector

The ValVector struct simply stores a 1D array containing the quantity of interest at each point on the grid.

Traits

GridQty

The GridQty trait is meant to leave open the possibility of in the future adding something like a GridVector struct that would store a vector value for each point on the grid as opposed to the scalar values stored by the GridScalar struct. However, it is more likely that this trait may be deprecated in the future and a GridVector struct would just contain a vector of GridScalars.

GridSpec

Since the physical space of the PDE can be defined in multiple coordinate systems, the GridSpec trait is used to identify those structs that can be used for this purpose. The trait defines the necessary methods for a struct that specifies a certain type of grid. For example, this trait is implemented by the CartesianGridSpec type. It would also need to be implemented for a SphericalGridSpec or PolarGridSpec.