Struct FoamCase 

pub struct FoamCase {
    pub root: PathBuf,
    pub system: Vec<(String, FoamFile)>,
    pub poly_mesh: Option<PolyMesh>,
    pub mesh: Option<Arc<FvMesh>>,
    pub time_dir: String,
    pub fields: Vec<CaseField>,
    pub skipped_fields: Vec<(String, String)>,
}

An in-memory OpenFOAM case.

Fields

root: PathBuf

The case root directory.

system: Vec<(String, FoamFile)>

system/ dictionaries, keyed by file name (controlDict, …).

poly_mesh: Option<PolyMesh>

The connectivity-carrying mesh from constant/polyMesh, if present.

mesh: Option<Arc<FvMesh>>

The geometry-carrying FV mesh derived from poly_mesh, if present.

time_dir: String

The time directory that was read (e.g. "0").

fields: Vec<CaseField>

Fields loaded from the time directory.

skipped_fields: Vec<(String, String)>

Field files skipped because their class is not a scalar/vector volume field ((file_name, class)).

Implementations

impl FoamCase

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

Read a case from root, using time directory "0".

pub fn read_time( root: impl AsRef<Path>, time_dir: &str, ) -> Result<Self, IoError>

Read a case from root, using the given time_dir (e.g. "0").

pub fn system_dict(&self, name: &str) -> Option<&FoamFile>

Look up a system/ dictionary by file name.

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

Best-effort write of the case back to root: system/ dictionaries, constant/polyMesh, and the scalar/vector fields into the time directory. Skipped (unsupported-class) fields are not re-emitted.

Trait Implementations

impl Clone for FoamCase

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FoamCase

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

Formats the value using the given formatter.