Skip to main content

section_properties/
lib.rs

1//! # section-properties
2//!
3//! Rust crate for structural cross-section analysis: geometric properties,
4//! plastic classification, warping/torsion constants, stress analysis, and
5//! 2D frame/beam finite element analysis.
6//!
7//! # Quick start — section properties
8//!
9//! ```rust
10//! use section_properties::{Point, Polygon, Section, SectionProperties};
11//!
12//! // Build a rectangle 10 × 5
13//! let outer = Polygon::new(vec![
14//!     Point::new(0.0, 0.0),
15//!     Point::new(10.0, 0.0),
16//!     Point::new(10.0, 5.0),
17//!     Point::new(0.0, 5.0),
18//! ]);
19//! let section = Section::new(outer, Vec::new());
20//! let props = SectionProperties::from_section(&section);
21//!
22//! assert!((props.area - 50.0).abs() < 1e-10);
23//! assert!((props.centroid.x - 5.0).abs() < 1e-10);
24//! assert!((props.centroid.y - 2.5).abs() < 1e-10);
25//! ```
26//!
27//! # Quick start — frame analysis
28//!
29//! See the [`frame`] module for a complete 2D frame example.
30//!
31//! # Module overview
32//!
33//! | Module                  | Purpose                                              |
34//! |-------------------------|------------------------------------------------------|
35//! | [`geometry`]            | Polygons, boolean ops, compound geometry             |
36//! | [`section`]             | Section (outer + holes), frame properties            |
37//! | [`section_properties`]  | Area, moments, principal axes, section moduli        |
38//! | [`composite`]           | Multi-material elastic transformed-section analysis  |
39//! | [`beam_fem`]            | 2D Euler-Bernoulli beam FEM                          |
40//! | [`frame`]               | 2D frame façade over beam FEM                        |
41//! | [`fea`]                 | FEM core: elements, solvers, diagnostics             |
42//! | [`plastic`]             | Plastic section analysis, warping, classification    |
43//! | [`material`]            | Isotropic linear-elastic material                    |
44//! | [`stress`]              | Cross-section stress analysis                        |
45//! | [`section_library`]     | Standard section shapes (I, channel, tube, …)        |
46//!
47//! # Error handling conventions
48//!
49//! * **Fallible constructors** use `try_new` / `new_validated` returning
50//!   `Result<Self, E>`.
51//! * **Fallible computations** use `try_*` returning `Result<T, E>` or
52//!   `Option<T>`.
53//! * **Panicking APIs** delegate to the `try_*` variant and `expect()` —
54//!   they document the panic condition in a `# Panics` section.
55//! * **Frame API** is fully fallible: all methods return `Result<T, FemError>`.
56
57pub mod beam_fem;
58pub mod cold_formed_analysis;
59pub mod composite;
60pub mod database;
61pub mod fea;
62pub mod fire;
63pub mod frame;
64pub mod geometry;
65pub mod io;
66pub mod material;
67pub mod mesh;
68pub mod plastic;
69pub mod post;
70pub mod section;
71pub mod section_library;
72pub mod section_properties;
73pub mod stress;
74pub mod stress_fem;
75
76pub use crate::cold_formed_analysis::{
77    BucklingCurve, ColdFormedElement, ColdFormedSection, EdgeSupport, EffectiveSectionProperties,
78    EffectiveWidthParams, ElementReduction, Stiffener, StiffenerType,
79};
80pub use crate::database::{
81    SearchFilter, SearchResult, SectionDatabase, SectionEntry, build_standard_database,
82};
83pub use crate::fire::{
84    FireAnalysis, FireExposure, FireProtection, FireResistanceResult, MaterialPropertiesAtTemp,
85    ProtectionType, SectionFactor, TemperatureProfile, composite as fire_composite,
86};
87pub use crate::geometry::{
88    Axis, BoundaryExtrema, CompoundError, CompoundGeometry, Geometry, JoinStyle, Point, Polygon,
89    Transform,
90};
91pub use crate::io::{
92    CsvExportOptions, DxfColor, DxfExportOptions, ExportFormat, JsonMaterial, JsonSection,
93    SectionExporter, SectionImporter, SvgExportOptions, export_section_library, from_csv,
94    from_json, plot_centroids, section_from_composite, section_from_parametric, to_csv, to_dxf,
95    to_json, to_nastran, to_svg, to_vtk,
96};
97
98pub use crate::beam_fem::{
99    BeamAnalysis, BeamElement, BeamModel, BeamNode, BeamSection, BeamSolver, Dof, FemError,
100};
101pub use crate::composite::{
102    ComponentAnalysis, CompositeAnalysisResult, CompositeComponent, CompositeError,
103    ElasticComposite,
104};
105pub use crate::fea::{
106    LagrangeKernel, SkylineLdlt, solver, solver::FactoredSolver, solver::LinearSolver,
107    solver::SelectionReason, solver::SolverBackend, solver::SolverCapabilities,
108    solver::SolverError, solver::SolverRegistry, solver::SolverSelection,
109    solver::SolverSelectionInfo, solvers,
110};
111pub use crate::frame::{
112    EquilibriumReport, FrameAnalysisResult, FrameModel, FrameSolver, MemberHandle, NodeHandle,
113};
114/// Alias for the interactive HTML viewer export.
115pub use crate::io::to_interactive_html as to_html;
116pub use crate::material::Material;
117pub use crate::mesh::{
118    AnalysisResults, ElementType, FemCompositeAnalysis, FemGeometricProperties, FemModel,
119    FemSectionAnalysis, FemSolver, FemWarpingProperties, LoadCase, MaterialProps, Mesh, MeshParams,
120    PropertyComparison, StressPlotData, StressPost, StressResult, analyze_section,
121};
122pub use crate::plastic::warping_fem::warping_svg;
123pub use crate::plastic::{
124    CapacityCheck, ClassLimit, InteractionDiagram, InteractionPoint, LoadCase3D, PlasticAnalysis,
125    PlasticProperties, PlasticSection, SectionClass, SectionClassification, StressDistribution,
126    TorsionAnalysis, WarpingProperties, aisc360, classify_section, effective, en1993,
127};
128pub use crate::section::{FrameProperties, MaterialError, Section, TransformedFrameProperties};
129pub use crate::section_library::{CompositeSection, ParametricSection};
130pub use crate::section_properties::{
131    GeometricProperties, GyrationProperties, PrincipalProperties, SectionProperties,
132};
133pub use crate::stress::{
134    SectionLoads, StressAnalysis, StressAnalysisResult, StressAtPoint, YieldCheckResult,
135};