MayaFlux 1.0.0
Digital-First Multimedia Processing Framework
Loading...
Searching...
No Matches
DuctGrid.cpp
Go to the documentation of this file.
1#include "DuctGrid.hpp"
2
4
5namespace {
6
7 constexpr size_t minimum_intervals = 2;
8 constexpr double maximum_intervals = 16777216.0;
9
10 [[nodiscard]] bool positive_finite(double value) noexcept
11 {
12 return std::isfinite(value) && value > 0.0;
13 }
14
15 [[nodiscard]] std::optional<double> interval_count(const DuctSpec& spec) noexcept
16 {
17 if (!positive_finite(spec.length) || !positive_finite(spec.sample_rate)
18 || !positive_finite(spec.sound_speed) || !positive_finite(spec.air_density)
19 || !std::isfinite(spec.mouth_volume) || spec.mouth_volume < 0.0) {
20 return std::nullopt;
21 }
22
23 const double count = std::floor(spec.length * spec.sample_rate / spec.sound_speed);
24 return count < maximum_intervals ? std::optional<double> { count } : std::nullopt;
25 }
26
27}
28
29size_t duct_intervals(const DuctSpec& spec) noexcept
30{
31 return static_cast<size_t>(interval_count(spec).value_or(0.0));
32}
33
34namespace detail {
35
36 std::expected<DuctGrid, DuctError> begin_duct_grid(const DuctSpec& spec)
37 {
38 const std::optional<double> count = interval_count(spec);
39 if (!count) {
40 return std::unexpected(DuctError::INVALID_SPEC);
41 }
42
43 const auto intervals = static_cast<size_t>(*count);
44 if (intervals < minimum_intervals) {
45 return std::unexpected(DuctError::TOO_SHORT);
46 }
47
48 DuctGrid grid;
49 grid.intervals = intervals;
50 grid.spacing = spec.length / static_cast<double>(intervals);
51 grid.time_step = 1.0 / spec.sample_rate;
52 grid.courant = std::min(1.0, spec.sound_speed * grid.time_step / grid.spacing);
53 grid.bandwidth = spec.sample_rate * std::asin(grid.courant) / std::numbers::pi;
54 grid.area.assign(intervals, 0.0);
55 return grid;
56 }
57
58 std::expected<DuctGrid, DuctError> finish_duct_grid(DuctGrid grid, const DuctSpec& spec)
59 {
60 const bool profile_valid = positive_finite(grid.start_radius) && positive_finite(grid.end_radius)
61 && std::ranges::all_of(grid.area, positive_finite);
62 if (!profile_valid) {
63 return std::unexpected(DuctError::INVALID_PROFILE);
64 }
65
66 const size_t intervals = grid.intervals;
67 const double k = grid.time_step;
68 const double h = grid.spacing;
69 const double rho = spec.air_density;
70 const double stiffness = rho * spec.sound_speed * spec.sound_speed * k;
71
72 grid.velocity_gain.resize(intervals);
73 grid.pressure_gain.resize(intervals + 1);
74
75 for (size_t l = 0; l < intervals; ++l) {
76 grid.velocity_gain[l] = k * grid.area[l] / (rho * h);
77 }
78
79 grid.pressure_gain[0] = stiffness / (0.5 * h * grid.area[0] + spec.mouth_volume);
80 for (size_t l = 1; l < intervals; ++l) {
81 grid.pressure_gain[l] = stiffness / (0.5 * h * (grid.area[l - 1] + grid.area[l]));
82 }
83 grid.pressure_gain[intervals] = stiffness / (0.5 * h * grid.area[intervals - 1]);
84
85 return grid;
86 }
87
88}
89
90std::expected<DuctGrid, DuctError> make_duct_grid(const DuctSpec& spec, std::span<const double> radii)
91{
92 auto begun = detail::begin_duct_grid(spec);
93 if (!begun) {
94 return begun;
95 }
96
97 if (radii.size() < 2 || !std::ranges::all_of(radii, positive_finite)) {
98 return std::unexpected(DuctError::INVALID_PROFILE);
99 }
100
101 DuctGrid grid = std::move(*begun);
102 const double last = static_cast<double>(radii.size() - 1);
103 for (size_t l = 0; l < grid.intervals; ++l) {
104 const double position = (static_cast<double>(l) + 0.5) / static_cast<double>(grid.intervals) * last;
105 const size_t index = std::min(static_cast<size_t>(position), radii.size() - 2);
106 const double fraction = position - static_cast<double>(index);
107 const double r = radii[index] + fraction * (radii[index + 1] - radii[index]);
108 grid.area[l] = std::numbers::pi * r * r;
109 }
110 grid.start_radius = radii.front();
111 grid.end_radius = radii.back();
112
113 return detail::finish_duct_grid(std::move(grid), spec);
114}
115
116} // namespace MayaFlux::Kinesis::Acoustics
Interleaved grid of a one dimensional acoustic bore.
std::expected< DuctGrid, DuctError > finish_duct_grid(DuctGrid grid, const DuctSpec &spec)
Definition DuctGrid.cpp:58
std::expected< DuctGrid, DuctError > begin_duct_grid(const DuctSpec &spec)
Definition DuctGrid.cpp:36
size_t duct_intervals(const DuctSpec &spec) noexcept
Number of grid intervals a spec allows.
Definition DuctGrid.cpp:29
std::expected< DuctGrid, DuctError > make_duct_grid(const DuctSpec &spec, std::span< const double > radii)
Build a grid from radii sampled evenly along the bore.
Definition DuctGrid.cpp:90
std::vector< double > velocity_gain
Definition DuctGrid.hpp:75
std::vector< double > pressure_gain
Definition DuctGrid.hpp:76
Prepared grid and update gains of one bore.
Definition DuctGrid.hpp:66
Physical and sampling constants a grid is built from.
Definition DuctGrid.hpp:31