Skip to main content

XdmfStructuredGrid

oxiphysics_io::xdmf::types

Struct XdmfStructuredGrid

pub struct XdmfStructuredGrid {
    pub name: String,
    pub ni: usize,
    pub nj: usize,
    pub nk: usize,
    pub origin: [f64; 3],
    pub dx: f64,
    pub dy: f64,
    pub dz: f64,
    pub node_scalars: Vec<(String, Vec<f64>)>,
    pub node_vectors: Vec<(String, Vec<[f64; 3]>)>,
    pub cell_scalars: Vec<(String, Vec<f64>)>,
}

Expand description

A structured (regular) Cartesian grid with optional scalar/vector fields.

This is the primary building block for CFD output on structured meshes.

Fields§

§name: String

Grid name shown in post-processors.

§ni: usize

Number of nodes along X (nodes = cells + 1 per axis).

§nj: usize

Number of nodes along Y.

§nk: usize

Number of nodes along Z.

§origin: [f64; 3]

Physical origin of the grid.

§dx: f64

Grid spacing along X.

§dy: f64

Grid spacing along Y.

§dz: f64

Grid spacing along Z.

§node_scalars: Vec<(String, Vec<f64>)>

Node-centered scalar fields (name, flat values, len = ni*nj*nk).

§node_vectors: Vec<(String, Vec<[f64; 3]>)>

Node-centered vector fields (name, flat values, len = ni*nj*nk).

§cell_scalars: Vec<(String, Vec<f64>)>

Cell-centered scalar fields (name, flat values, len = (ni-1)*(nj-1)*(nk-1)).

Implementations§

impl XdmfStructuredGrid

pub fn new( name: &str, ni: usize, nj: usize, nk: usize, origin: [f64; 3], dx: f64, dy: f64, dz: f64, ) -> Self

Create a new structured grid with no fields.

pub fn n_nodes(&self) -> usize

Total node count.

pub fn n_cells(&self) -> usize

Total cell count.

pub fn add_node_scalar(&mut self, name: &str, data: Vec<f64>)

Add a node-centered scalar field.

pub fn add_node_vector(&mut self, name: &str, data: Vec<[f64; 3]>)

Add a node-centered vector field.

pub fn add_cell_scalar(&mut self, name: &str, data: Vec<f64>)

Add a cell-centered scalar field.

pub fn to_xml(&self) -> String

Serialize the structured grid to XDMF XML using ORIGIN_DXDYDZ geometry.

Trait Implementations§

impl Clone for XdmfStructuredGrid

fn clone(&self) -> XdmfStructuredGrid

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for XdmfStructuredGrid

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for XdmfStructuredGrid

impl RefUnwindSafe for XdmfStructuredGrid

impl Send for XdmfStructuredGrid

impl Sync for XdmfStructuredGrid

impl Unpin for XdmfStructuredGrid

impl UnsafeUnpin for XdmfStructuredGrid

impl UnwindSafe for XdmfStructuredGrid

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.