Data

Tools

Indexes

Applications

Experiments

Open Source Science

R3D2

R3D2: Relativistic Reactive Riemann problem solver for Deflagrations and Detonations - Published in JOSS (2016)

https://github.com/harpolea/r3d2

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 1 DOI reference(s) in JOSS metadata
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    2 of 4 committers (50.0%) from academic institutions
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Mathematics Computer Science - 40% confidence
Last synced: 6 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: harpolea
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: master
  • Size: 13.3 MB
Statistics
  • Stars: 6
  • Watchers: 3
  • Forks: 2
  • Open Issues: 2
  • Releases: 2
Created about 10 years ago · Last pushed over 6 years ago
Metadata Files
Readme License

README.rst 

R3D2 
====

.. image:: https://travis-ci.org/harpolea/r3d2.svg?branch=master
    :target: https://travis-ci.org/harpolea/r3d2
.. image:: https://readthedocs.org/projects/r3d2/badge/?version=latest
    :target: http://r3d2.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
.. image:: https://codecov.io/github/harpolea/r3d2/coverage.svg?branch=master
    :target: https://codecov.io/github/harpolea/r3d2?branch=master
.. image:: https://zenodo.org/badge/21891/harpolea/r3d2.svg
    :target: https://zenodo.org/badge/latestdoi/21891/harpolea/r3d2

Relativistic Reactive Riemann problem solver for Deflagrations and Detonations
------------------------------------------------------------------------------

This extends standard solutions of the relativistic Riemann Problem to include a reaction term.

Models of ideal hydrodynamics, where there is no viscosity or dissipation, can have solutions with *discontinuities* such as shocks. A simple case is the Riemann Problem, where two constant states are separated by a barrier. After the barrier is removed the solution develops, with *waves* (such as shocks and rarefactions) separating constant states.

The Riemann Problem has three main uses. Efficient, often approximate, solvers are an integral part of many modern hydrodynamic evolution codes. Second, the exact solution is a standard test for such codes. Finally, the solver can illustrate features of discontinuous solutions in more complex scenarios.

This code is intended for exploring possible solutions and relativistic effects, or for comparing against a compressible code with reactive sources. It is optimized for use with Jupyter notebooks. It is **not** intended for use within a HRSC evolution code: the performance is far too poor, and the assumptions made too extreme.

Installation
------------

A standard::

    python setup.py install

or::

    pip install r3d2

should work.

Usage
-----

Import the equations of state, State class, and Riemann Problem class:
::

    >>> from r3d2 import eos_defns, State, RiemannProblem

Set up an equation of state:
::

    >>> eos = eos_defns.eos_gamma_law(5.0/3.0)

Set up the left and right states:
::

    >>> U_L = State(rho=1.0, v=0.0, vt=0.0, eps=1.5, eos=eos)
    >>> U_R = State(rho=0.125, v=0.0, vt=0.0, eps=1.2, eos=eos)

Solve the Riemann Problem:
::

    >>> rp = RiemannProblem(U_L, U_R)

The output can be examined for details of the solution and its wave structure. For example, the three waves are each built of wave *sections*, which can be examined to check their type, via e.g.

    >>> rp.waves[0].wave_sections

and its speed (or the range of speeds) can be examined via

    >>> rp.waves[0].wavespeed

The states that the waves separate can be found via, e.g.,

    >>> rp.waves[0].q_r

and the detailed values via

    >>> rp.waves[0].q_r.state()

However, the classes are optimized for display in a Jupyter notebook. See the documentation for more detail.

Documentation
-------------

The documentation is available at ``_ .

Contributing
------------

Please open a pull request at ``_ .

Support
-------

Please open an issue at ``_ .

Owner

  • Name: Alice Harpole
  • Login: harpolea
  • Kind: user
  • Company: Stony Brook University

Postdoc at Stony Brook University modelling explosions in space.

JOSS Publication

R3D2: Relativistic Reactive Riemann problem solver for Deflagrations and Detonations
Published
May 27, 2016
DOI
Volume 1, Issue 1, Page 16
Authors
Alice Harpole ORCID
University of Southampton
Ian Hawke ORCID
University of Southampton
Editor
Arfon Smith ORCID
Tags
hydrodynamics Riemann problem relativity reactions
View PDF Review Thread Software Archive

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 210
  • Total Committers: 4
  • Avg Commits per committer: 52.5
  • Development Distribution Score (DDS): 0.324
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Ian Hawke I****e@s****k 142
harpolea a****4@s****k 41
Alice Harpole h****a 26
Kyle Niemeyer k****r@g****m 1
Committer Domains (Top 20 + Academic)
soton.ac.uk: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 3
  • Total pull requests: 7
  • Average time to close issues: about 6 hours
  • Average time to close pull requests: about 19 hours
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 3.33
  • Average comments per pull request: 0.43
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • IanHawke (2)
  • zengbs (1)
Pull Request Authors
  • IanHawke (5)
  • harpolea (1)
  • kyleniemeyer (1)
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 22 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 2
  • Total versions: 2
  • Total maintainers: 1
pypi.org: r3d2

Relativistic Reactive Riemann problem solver for Deflagrations and Detonations

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 2
  • Downloads: 22 Last month
Rankings
Dependent packages count: 10.1%
Dependent repos count: 11.6%
Forks count: 19.2%
Stargazers count: 23.1%
Average: 30.2%
Downloads: 87.0%
Maintainers (1)
harpolea
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • IPython >=3
  • ipykernel *
  • matplotlib >=1.5
  • nbsphinx *
  • numpy *
  • scipy >=0.10
setup.py pypi
  • matplotlib *
  • numpy *
  • scipy *