Skip to content

ElsevierSoftwareX/SOFTX-D-20-00063

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

96 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ODT

This code implements the One-Dimensional Turbulence (ODT) model for turbulent reacting or nonreacting flows.

Documentation

Detailed documentation is available here. More information on the theory and application of ODT is available here.

A short video overview summarizing downloading, building, running, and processing the code is shown here.

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 code
  • data: 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 run folder.
      • This case subfolder will contain subfolders input, runtime, data, and post, which contain the input data files, runtime output, simulation data files, and post-processed data, respectively.
  • doc: contains documentation files
  • input: contains case input files
    • Other input files include a Cantera mechanism file in the user_gas_mechanisms folder and an optional restart.yaml file.
  • 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.
  • run: contains the code executable odt.x and 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.
  • source: contains source code (including header files) and CMakeLists.txt files

About

One-dimensional turbulence (ODT): computationally efficient modeling and simulation of turbulent flows. To cite this software publication: https://www.sciencedirect.com/science/article/pii/S235271102030354X

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 39.3%
  • C 26.9%
  • Jupyter Notebook 16.4%
  • Python 15.3%
  • Shell 0.9%
  • CMake 0.9%
  • Gnuplot 0.3%