radlib

Radiation property library for combustion gases and soot

https://github.com/byuignite/radlib

Science Score: 57.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
Found 2 DOI reference(s) in README
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (12.1%) to scientific vocabulary

Last synced: 7 months ago · JSON representation ·

Repository

Radiation property library for combustion gases and soot

Basic Info

Host: GitHub
Owner: BYUignite
License: mit
Language: C++
Default Branch: master
Size: 35.7 MB

Statistics

Stars: 10
Watchers: 2
Forks: 4
Open Issues: 0
Releases: 1

Created almost 6 years ago · Last pushed almost 2 years ago

Metadata Files

Readme License Citation

README.md

Publication

This code is described in the following publication:

V.B. Stephens, S. Jensen, I. Wheeler, D.O. Lignell, “RadLib: a radiative heat transfer model library for CFD,” Computer Physics Communications, 272:108227, (2022).

A Code Ocean Capsule is also available.

A youtube video demonstrates building the code and running examples.

Building RadLib

Dependencies

The code is intended to be built on Linux and MacOS systems (or the Linux subsystem for Windows).

Required software: * CMake 3.15+

Optional software and Python packages for building the Python interface: * Python 3.x * Cython 0.29.21 * distutils * numpy * glob

Optional Python packages for running the Python examples * matplotlib * numpy * Jupyter

Optional software for building documentation: * Doxygen * graphviz

Build instructions

Create a directory build and navigate to it.
Run CMake: cmake ..
Build radlib: make
Install radlib: make install
(OPTIONAL) Build documentation: make docs
(CLEANUP) Clean build files: run git clean -d -f -x from top-level directory

Notes

See the top of the root CMakeLists.txt file for build options.
The code defaults to building the Python and Fortran interfaces, along with the C++, Python, and Fortran examples. The documentation build is off by default. These options can be changed in the CMakeLists.txt file, or at the command line. For example,
- cmake -DBUILD_PYTHON_INTERFACE=OFF ..

Default installation locations

C++
- library: libradlib.a is located in installed/lib
- header files: rad_planck_mean.h, rad_rcslw.h, rad_wsgg.h are located in installed/include
Fortran
- library: libradlib_fortran.a is located in installed/lib
- module file: rad_module.mod is located in installed/include
  - This is included is user code with the use rad_module statement.
Python
- package pyrad.cpython-38-darwin.so is located in installed/lib/python3.8/site- packages. Note that the actual file names may differ depending on the machine and Python installation.
  - The Python package is included in user code with statements such as from pyrad import prad_rcslw
CMake
- Relocatable package radlib.cmake is located in installed/cmake/radlib
- Relocatable package radlib_fortran.cmake located in installed/cmake/radlib_fortran

Documentation

Documentation is availale at ignite.byu.edu/radlib_documentation.

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: "RadLib, radiation property library for combustion gases"
version: 1.3
identifiers:
  - type: doi
    value: 10.5281/zenodo.12536606
date-released: 2024-06-25
url: https://github.com/BYUignite/radlib
preferred-citation:
  type: article
  authors:
  - family-names: Stephens
    given-names: Victoria B
  - family-names: Jensen
    given-names: Sally
  - family-names: Wheeler
    given-names: Isaac S
  - family-names: Lignell
    given-names: David O
    orcid: https://orcid.org/0000-0002-2129-1375
  doi: 10.5281/zenodo.12536606
  journal: "Computer Physics Communications"
  start: 108227 # First page number
  title: "RadLib: A radiative property library for CFD"
  volume: 272
  year: 2022

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science