Skip to main content

Crate plot3d

Crate plot3d 

Source
Expand description

Plot3D utilities for mesh connectivity, periodicity detection, and I/O.

The crate deliberately mirrors the structure of the legacy Python tooling. For a walkthrough of the rotational periodicity workflow refer to the integration test tests/test_rotational_periodicity.rs::rotational_periodicity_test, which doubles as a usage example in the generated documentation (cargo doc --open).

§Diagonal Convention (FaceRecord)

FaceRecord uses il/jl/kl and ih/jh/kh to describe the two diagonal corners of a face on a block. These are not guaranteed to satisfy il <= ih; the ordering encodes orientation. When il > ih, the I-axis is reversed on that face relative to the matching face on the other block.

This matches the GridPro/GlennHT connectivity convention where IMIN,JMIN,KMIN → IMAX,JMAX,KMAX are diagonal corners and reversed indices encode face orientation.

Use the normalized accessors i_lo()/i_hi() when you need min/max values for range iteration or face reconstruction.

Re-exports§

pub use block::Block;
pub use block::FaceData;
pub use block_analysis::block_connection_matrix;
pub use block_analysis::build_connectivity_graph;
pub use block_analysis::calculate_outward_normals;
pub use block_analysis::check_collinearity;
pub use block_analysis::find_bounding_faces;
pub use block_analysis::find_closest_block;
pub use block_analysis::get_outer_bounds;
pub use block_analysis::standardize_block_orientation;
pub use block_analysis::BlockConnectionOptions;
pub use block_face_functions::create_face_from_diagonals;
pub use block_face_functions::full_face_match;
pub use block_face_functions::full_face_match_transformed;
pub use block_face_functions::get_outer_faces;
pub use block_face_functions::reduce_blocks;
pub use block_face_functions::rotate_block;
pub use block_face_functions::Face;
pub use connectivity::connectivity;
pub use connectivity::connectivity_fast;
pub use connectivity::face_matches_to_dict;
pub use connectivity::get_face_intersection;
pub use connectivity::verify_connectivity;
pub use cylindrical::find_angular_bounding_faces;
pub use cylindrical::to_radius;
pub use cylindrical::to_theta;
pub use differencing::find_edges;
pub use differencing::find_face_edges;
pub use differencing::BlockDiff;
pub use differencing::FaceDiff;
pub use face_record::FaceKey;
pub use face_record::FaceMatch;
pub use face_record::FaceMatchPrinter;
pub use face_record::FaceRecord;
pub use face_record::FaceRecordTraits;
pub use face_record::MatchPoint;
pub use face_record::Orientation;
pub use face_record::PeriodicPair;
pub use graph::build_weighted_graph_from_face_matches;
pub use graph::write_ddcmp;
pub use graph::BlockGraph;
pub use graph::WeightAggregate;
pub use merge_blocks::combine_2_blocks_mixed_pairing;
pub use merge_blocks::combine_blocks_mixed_pairs;
pub use merge_blocks::combine_nxnxn_cubes_mixed_pairs;
pub use point_match::point_match;
pub use read::read_ap_nasa;
pub use read::read_plot3d_ascii;
pub use read::read_plot3d_binary;
pub use read::BinaryFormat;
pub use read::FloatPrecision;
pub use rotational_periodicity::count_rotated_corners_on_face;
pub use rotational_periodicity::create_rotation_matrix;
pub use rotational_periodicity::faces_support_any;
pub use rotational_periodicity::faces_support_direction;
pub use rotational_periodicity::linear_real_transform;
pub use rotational_periodicity::periodicity_check_with_points;
pub use rotational_periodicity::rotate_block_with_matrix;
pub use rotational_periodicity::rotated_periodicity;
pub use rotational_periodicity::rotational_periodicity;
pub use rotational_periodicity::verify_periodicity;
pub use split_block::split_blocks;
pub use split_block::SplitDirection;
pub use translational_periodicity::translational_periodicity;
pub use utils::apply_rotation;
pub use utils::Endian;
pub use write::write_plot3d;

Modules§

block
block_analysis
Block-level analysis: connectivity graphs, orientation standardization, bounding face detection, and outward normal computation.
block_face_functions
connectivity
Block-to-block face connectivity detection.
cylindrical
Cylindrical coordinate transforms and angular bounding face detection.
differencing
Forward and backward differencing for structured grid edges.
face_pool
Cylindrical-coordinate face pool and edge matching utilities for rotational periodicity detection.
face_record
Core data types for face connectivity: FaceRecord, FaceMatch, MatchPoint, and Orientation.
graph
Graph partitioning utilities for structured multi-block grids.
merge_blocks
point_match
Point matching utilities for structured grid faces.
read
rotational_periodicity
Utilities for detecting rotational periodicity in structured multi-block grids.
split_block
Block splitting utilities that preserve multi-grid compatibility.
translational_periodicity
Translational periodicity detection for structured multi-block grids.
utils
write

Constants§

PI
Pi constant matching the active Float precision. Archimedes’ constant (π)

Type Aliases§

Float
Floating-point precision type used throughout the crate. Defaults to f64; enable the f32 Cargo feature for single precision.