Enum omf::Grid3

pub enum Grid3 {
    Regular {
        size: Vector3,
        count: [u32; 3],
    },
    Tensor {
        u: Array<Scalar>,
        v: Array<Scalar>,
        w: Array<Scalar>,
    },
}

Defines a 3D grid spacing and size.

Variants

Regular

Regularly spaced cells.

Fields

size: Vector3

The block size in the U and V axes. All must be greater than zero.

count: [u32; 3]

The number of cells in the U, V, and W axes. All must be greater than zero.

Tensor

Tensor cells, where each row, column, and layer can have a different size. All sizes must be greater than zero.

Fields

u: Array<Scalar>

Array with Scalar type storing the size of each cell along the U axis. These sizes must be greater than zero.

v: Array<Scalar>

Array with Scalar type storing the size of each cell along the V axis. These sizes must be greater than zero.

w: Array<Scalar>

Array with Scalar type storing the size of each cell along the W axis. These sizes must be greater than zero.

Implementations

impl Grid3

pub fn from_size_and_count(size: Vector3, count: [u32; 3]) -> Self

Create a 3D regular grid from the block size and count.

pub fn from_arrays(u: Array<Scalar>, v: Array<Scalar>, w: Array<Scalar>) -> Self

Create a 3D tensor grid from the size arrays.

pub fn count(&self) -> [u32; 3]

Returns the number of blocks in each axis.

pub fn flat_count(&self) -> u64

Returns the total number of blocks.

pub fn flat_corner_count(&self) -> u64

Returns the total number of block corners.

Trait Implementations

impl Clone for Grid3

fn clone(&self) -> Grid3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Grid3

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

Formats the value using the given formatter.

impl Default for Grid3

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Grid3

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Grid3

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for Grid3

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Grid3

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for Grid3

fn validate(&mut self) -> Result<Problems, Problems>

Call to validate the object, returning errors and warnings.

impl StructuralPartialEq for Grid3