This is the public repository for the The Community Hub for Open-source Room Acoustics Software. Follow the steps described in setup_instructions.md to run CHORAS using Docker!
This section provides a description of the simulation specific settings in CHORAS. The settings marked with a 🟨 or 🟥 greatly influence simulation time (🟥 has a greater influence).
-
Diffusion Equation method
-
Simulation length: Determines whether to use Impulse response length or Energy decay threshold to determine the simulation length
-
🟨 Impulse response length: Sets the length of the generated impulse response (only used when Simulation length is set to IR Length!)
-
Speed of sound: The speed of sound
-
🟨 Energy decay threshold: The (negative) dB value that the simulation will run until (only used when Simulation length is set to EDT).
-
🟥 Characteristic length: The length between two mesh nodes that the mesher tries to aim for. (This greatly influences simulation time. Start with 3, especially for a larger geometry (such as the Room2215 geometries))
-
🟥 Additional note on surfaces: a low average absorption drastically increase the simulation time (start with Upholstered concert chairs for all surfaces for prototyping)
-
-
Discontinuous Galerkin method
- Speed of sound: The speed of sound
- 🟥 Impulse Response Length: Sets the length of the generated impulse response (greatly influences simulation time. Start with 0.1 s for prototyping.)
- 🟥 Frequency upper limit: The highest frequency that DG will generate. (greatly influences simulation time. Start with 100 Hz for prototyping.)
- Air density: The density of the air
- Poly order: The polynomial order of the DG method (better to leave this untouched)
- Points per wavelength: The number of points per wavelength to use in the DG method (better to leave this untouched)
- CFL: The Courant–Friedrichs–Lewy condition (better to leave this untouched)
You'll find two submodules in this repository:
- frontend-v2
- backend
You won't need these if you simply want to run the Docker setup described in setup_instructions.md.
If you are interested in the underlying code anyway, run
git submodule update --init --recursiveExamples of geometries compatible with CHORAS in the example_geometries folder.
If you are a developer of a room acoustics simulation back-end, please refer to the backend readthedocs.
Note that if you have issues with cloning this repository (and its submodules), you can download the zipped repository via the releases page of this repository: https://github.com/choras-org/CHORAS/releases.