Skip to content

Commit e733292

Browse files
authored
Update readme (#155)
1 parent e2c9796 commit e733292

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.rst

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,17 @@ MARBLES: Multi-scale Adaptively Refined Boltzmann LatticE Solver
1818
.. |C++ Badge| image:: https://img.shields.io/badge/language-C%2B%2B17-blue
1919
:target: https://isocpp.org/
2020

21-
21+
MARBLES (Multi-scale Adaptively Refined Boltzmann LatticE Solver) is a
22+
computational fluid dynamics solver that leverages the lattice
23+
Boltzmann method (LBM) and block-structured adaptive mesh refinement
24+
(AMR) to simulate flows in complex media. MARBLES supports various
25+
parallel decomposition strategies, including the use of the Message
26+
Passing Interface (MPI) and OpenMP threading. All major GPU
27+
architectures (e.g., Intel, AMD, NVIDIA) are supported through the use
28+
of performance portability functionalities implemented in AMReX. The
29+
MARBLES software is released in NREL Software Record `SWR-23-37
30+
<https://doi.org/10.11578/dc.20231009.2>`_ “MARBLES (Multi-scale
31+
Adaptively Refined Boltzmann LatticE Solver)”.
2232

2333
Getting Started
2434
~~~~~~~~~~~~~~~
@@ -60,3 +70,8 @@ The full documentation for `MARBLES` exists in the Docs directory; at present th
6070
Or, using cmake ::
6171

6272
$ cd Build && cmake -B build-docs ../Docs && cmake --build build-docs
73+
74+
Funding
75+
~~~~~~~
76+
77+
This work was authored by the National Renewable Energy Laboratory (NREL) for the U.S. Department of Energy (DOE) under Contract No. DE-AC36-08GO28308. This work was supported by the Laboratory Directed Research and Development (LDRD) Program at NREL. The views expressed in the article do not necessarily represent the views of the DOE or the U.S. Government. The U.S. Government retains and the publisher, by accepting the article for publication, acknowledges that the U.S. Government retains a nonexclusive, paid-up, irrevocable, worldwide license to publish or reproduce the published form of this work, or allow others to do so, for U.S. Government purposes. A portion of the research was performed using computational resources sponsored by the Department of Energy’s Office of Energy Efficiency and Renewable Energy and located at the National Renewable Energy Laboratory.

0 commit comments

Comments
 (0)