Skip to main content

PolyMesh

Struct PolyMesh 

Source
pub struct PolyMesh {
    pub points: Vec<Vector3>,
    pub faces: Vec<MeshFace>,
    pub n_internal_faces: usize,
    pub n_cells: usize,
    pub patches: Vec<BoundaryPatch>,
}
Expand description

A connectivity-carrying poly-mesh — the on-disk polyMesh representation.

Faces are ordered internal-first ([0, n_internal_faces)), then boundary faces grouped by patch, matching OpenFOAM. Call PolyMesh::to_fv_mesh to obtain the geometry-carrying FvMesh.

Fields§

§points: Vec<Vector3>

Mesh points [m].

§faces: Vec<MeshFace>

All faces, internal first then boundary.

§n_internal_faces: usize

Number of internal faces (leading internal entries in faces).

§n_cells: usize

Number of cells.

§patches: Vec<BoundaryPatch>

Boundary patches, covering [n_internal_faces, faces.len()).

Implementations§

Source§

impl PolyMesh

Source

pub fn n_points(&self) -> usize

Number of points.

Source

pub fn n_faces(&self) -> usize

Total number of faces (internal + boundary).

Source

pub fn n_boundary_faces(&self) -> usize

Number of boundary faces.

Source

pub fn total_volume(&self) -> f64

Total mesh volume [m^3] — the sum of all cell volumes.

Source

pub fn to_fv_mesh(&self) -> Result<FvMesh, IoError>

Convert to the geometry-carrying FvMesh, computing cell volumes/centres, face-area vectors, face areas, and face centres from the point/face topology.

§Errors

IoError::Mesh if the assembled mesh fails FvMesh::validate.

Source

pub fn read(dir: impl AsRef<Path>) -> Result<Self, IoError>

Read a polyMesh from a constant/polyMesh directory.

Reads points, faces, owner, neighbour, and boundary.

Source

pub fn write(&self, dir: impl AsRef<Path>) -> Result<(), IoError>

Write the polyMesh files into dir, creating it if necessary.

Trait Implementations§

Source§

impl Clone for PolyMesh

Source§

fn clone(&self) -> Self

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
Source§

impl Debug for PolyMesh

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for PolyMesh

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PolyMesh

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.