Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: sciencedirect.com -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (16.0%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: BYUignite
- License: mit
- Language: C++
- Default Branch: master
- Size: 21.4 MB
Statistics
- Stars: 9
- Watchers: 1
- Forks: 7
- Open Issues: 1
- Releases: 1
Metadata Files
README.md
ODT
This code implements the One-Dimensional Turbulence (ODT) model for turbulent reacting or nonreacting flows. See also the Basic ODT implementation.
Documentation
Detailed documentation is available here. More information on the theory and application of ODT is available here.
A publication detailing this code is provided in the following reference:
V.B. Stephens, D.O. Lignell, “One-dimensional turbulence (ODT): computationally efficient modeling and simulation of turbulent flows,” SoftwareX, 13:100641 (2020).
A short video overview summarizing downloading, building, running, and processing the code is shown here.
A Code Ocean module that provides a runable version of the installed code is also available.
Dependencies
ODT Code
- Cantera: open-source suite of tools for problems involving chemical kinetics, thermodynamics, and transport.
- Yaml: input file format. This installation is conveniently built into the ODT build process.
- Cmake 3.12 or higher
- (OPTIONAL) Doxygen: builds documentation.
Post-processing
Post-processing data produced by ODT and ODT is processed via Python 3 scripts. We recommend Python 3.2 or higher. Scripts may not function properly using Python 2.x. The following packages are required and can be installed via pip3: * numpy * scipy * matplotlib * glob * yaml * sys * os
Directory structure
build: build the codedata: contains all data files output during a simulation- The code will generate a subfolder with a name corresponding to case name specified in the run script in the
runfolder.- This case subfolder will contain subfolders
input,runtime,data, andpost, which contain the input data files, runtime output, simulation data files, and post-processed data, respectively.
- This case subfolder will contain subfolders
- The code will generate a subfolder with a name corresponding to case name specified in the run script in the
doc: contains documentation filesinput: contains case input files- Other input files include a Cantera mechanism file in the
user_gas_mechanismsfolder and an optionalrestart.yamlfile.
- Other input files include a Cantera mechanism file in the
post: contains post-processing scripts and files for given case types- Output is placed in
data/caseName/post. These are mostly Python files. Some cases also include experimental data files for comparison and plotting.
- Output is placed in
run: contains the code executableodt.xand several run scripts- The user specifies inputDir as the path to the input file containing the case to run and specifies a case name for variable caseName. Files are created and copied into
data/caseName, as noted above.
- The user specifies inputDir as the path to the input file containing the case to run and specifies a case name for variable caseName. Files are created and copied into
source: contains source code (including header files) andCMakeLists.txtfiles
Owner
- Name: David Lignell
- Login: BYUignite
- Kind: user
- Location: Provo Utah USA
- Company: Brigham Young University
- Website: https://ignite.byu.edu
- Repositories: 4
- Profile: https://github.com/BYUignite
Professor, Chemical Engineering, Brigham Young University
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Lignell
given-names: David
orcid: https://orcid.org/0000-0002-2129-1375
- family-names: Stephens
given-names: Victoria
title: ODT, One dimensional turbulence model
version: 1.0
identifiers:
- type: doi
value: 10.5281/zenodo.12537049
date-released: 2024-06-25
url: https://github.com/BYUignite/odt
preferred-citation:
type: article
authors:
- family-names: Stephens
given-names: Victoria B
- family-names: Lignell
given-names: David O
orcid: https://orcid.org/0000-0002-2129-1375
doi: 10.5281/zenodo.12537049
journal: SoftwareX
start: 100641
title: "One-dimensional turbulence (ODT): computationally efficient modeling and simulation of turbulent flows"
volume: 13
year: 2020
GitHub Events
Total
- Push event: 7
- Fork event: 1
Last Year
- Push event: 7
- Fork event: 1