Fire is a framework for modeling and simulation. It includes various reusable tools and utilities for solving computational physics problems. This includes
- parsers
- steppers
- solvers
- a finite element library
It also includes domain-specific classes and tools for
- kinetic rate theory calculations in nuclear astrophysics
- heat conduction and diffusion
- sintering
- welding
Documentation in Fire is generated via Doxygen by running "make doc" during the build. The documentation is viewable online. The full API documentation is available at the API reference page.
You can run "make doc" from build directory to generate the API documentation. Doxygen handles most of the required documentation without developer intervention. This means that in some cases there may be classes that seem to have minimal documentation in the source, like classes that implement interfaces and provide no additional functionality, but are in fact quite well documented by Doxygen. Most IDEs will also auto-generate descriptions for developers too, so the author(s) see no need to cover every piece of code with comments.
You will need git and cmake to build Fire.
From a shell, execute the following commands to compile the code:
git clone https://github.com/jayjaybillings/fire
mkdir fire-build
cd fire-build
cmake ../fire -DCMAKE_BUILD_TYPE=Debug -G"Eclipse CDT4 - Unix Makefiles" -DCMAKE_ECLIPSE_VERSION=4.5
makeIf you would like to use MAGMA for solvers, you need to modify the cmake argument with the path to the MAGMA installation. Your configuration statement should look like the following:
cmake ../fire -DCMAKE_BUILD_TYPE=Debug -G"Eclipse CDT4 - Unix Makefiles" -DCMAKE_ECLIPSE_VERSION=4.5 -DMAGMA_ROOT=/usr/local/libFire also supports CVODE, which can be used by either passing -DSUNDIALS_ROOT or pointing to Spack:
cmake ../fire -DCMAKE_BUILD_TYPE=Debug -G"Eclipse CDT4 - Unix Makefiles" -DCMAKE_ECLIPSE_VERSION=4.5 -DMAGMA_ROOT=/usr/local/lib -DSPACK_ROOT=$HOME/spackThe above will get the code running, but it will not run the tests or generate the documentation. Issue the following commands to do that:
make test
make docBuild flags, such as -Wall, can be set by prepending the CXX_FLAGS variable to the cmake command as such
CXX_FLAGS='-Wall' cmake ../fire -DCMAKE_BUILD_TYPE=Debug -G"Eclipse CDT4 - Unix Makefiles" -DCMAKE_ECLIPSE_VERSION=4.5Optimization flags should be handled by setting -DCMAKE_BUILD_TYPE=Release instead of Debug. Likewise, an optimized build with debug information can be acheived by setting -DCMAKE_BUILD_TYPE=RelWithDebugInfo.
If Fire is to be deployed as a third party library, then it should be installed to a proper installation directory. This can be done by passing the -DCMAKE_INSTALL_PREFIX option during configuration as follows:
cmake ../fire -DCMAKE_INSTALL_PREFIX=/awesome-install-directory -DCMAKE_BUILD_TYPE=Debug -G"Eclipse CDT4 - Unix Makefiles" -DCMAKE_ECLIPSE_VERSION=4.5 -DMAGMA_ROOT=/usr/local/libSee the LICENSE file licensing and copyright information. In short, 3-clause BSD.
Questions can be directed to me at jayjaybillings gmail com.