https://github.com/kanamesasaki/sterad
Library for calculating radiation view factors and solid angles in various geometrical configurations
https://github.com/kanamesasaki/sterad
radiative-transfer raytracing rust thermal
Last synced: 6 months ago
JSON representation
Library for calculating radiation view factors and solid angles in various geometrical configurations
- Host: GitHub
- URL: https://github.com/kanamesasaki/sterad
- Owner: kanamesasaki
- License: mit
- Created: 2025-01-21T20:12:42.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-02-27T19:16:08.000Z (8 months ago)
- Last Synced: 2025-02-28T03:48:57.490Z (7 months ago)
- Topics: radiative-transfer, raytracing, rust, thermal
- Language: Rust
- Homepage:
- Size: 52.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sterad
**sterad** is a collection of Rust crates for calculating radiation view factors and solid angles, both analytically and numerically.
The main goal is to provide reliable, performant, and modular functionalities for scientific and engineering applications related to thermal radiation, nuclear engineering, illuminating engineering, computer graphics, and so on.
## Overview
The **sterad** repository hosts multiple Rust crates, each specializing in different aspects of calculating solid angles, radiation view factors, and numerical (ray-tracing) solutions:
1. [sterad-view-factor](./crates/sterad-view-factor)
Analytical and semi-analytical computations of radiation view factors between surfaces.
2. [sterad-solid-angle](./crates/sterad-solid-angle)
Analytical computations of solid angles for various geometries.
3. [sterad-numerical](./crates/sterad-numerical)
Ray-tracing and numerical methods for calculating solid angles, view factors, or other geometric measures.
## Features
- **Analytical Computations**: Compute solid angles and view factors for primitive shapes (rectangles, disks, spheres, cones, polygons, etc.).
- **Numerical Ray Tracing**: Monte Carlo-based ray tracing approaches for approximating view factors and solid angles.
- **Modular Design**: Each crate is independent and can be used separately or combined.
- **Rust Integration**: Written in pure Rust, designed to be efficient and safe.
## Installation
Each crate can be included in your `Cargo.toml`:
```toml
[dependencies]
sterad-view-factor = { git = "https://github.com/kanamesasaki/sterad", package = "sterad-view-factor" }
sterad-solid-angle = { git = "https://github.com/kanamesasaki/sterad", package = "sterad-solid-angle" }
sterad-numerical = { git = "https://github.com/kanamesasaki/sterad", package = "sterad-numerical" }
```
## Usage
Here are some examples of how to use the crates:
```rust
// Example for sterad-view-factor
use sterad_view_factor::diff_element_to_disk;
let h: f64 = 2.0;
let r: f64 = 1.0;
let vf: f64 = diff_element_to_disk::parallel_center(h, r).unwrap();
assert!((vf - 0.2).abs() < 1e-10);
```
```rust
// Example for sterad-solid-angle
use sterad_solid_angle::point_to_disk;
use std::f64::consts::PI;
let h = 4.0;
let r = 3.0;
let result = point_to_disk::center(h, r).unwrap();
assert!((result - 0.4 * PI).abs() < 1e-10);
```
## Contributing
Contributions are welcome! Please open an issue or submit a pull request if you have suggestions for improvements, bug fixes, or additional features.
## License
This project is licensed under the MIT License.