Getting Started

At it’s most basic, you can download and compile singularity-eos with:

git clone --recursive git@github.com:lanl/singularity-eos.git
cd singularity-eos
mkdir bin
cd bin
cmake -DSINGULARITY_FORCE_SUBMODULE_MODE=ON -DSINGULARITY_USE_FORTRAN=OFF ..
make -j
make install # optional: install into directory defined via CMAKE_INSTALL_PREFIX

This will download singularity-eos with no optional dependencies and compile the capabilities available in that form. For more details, see our build page.

If the library is in your include and lib paths (or you built it in-tree), you can include the eos part of the library with

#include<singularity-eos/eos/eos.hpp>

You can then initialize an equation of state by setting the model class you want to an EOS object. For example:

EOS ideal = IdealGas(gm1, Cv);

To see which equations of state are available, see The Equation of State API.

Some equations of state store tabulated data.

Warning

If you want to run one of these on an accelerator device like a GPU, you must copy the data over. This is provided by the function

EOS::GetOnDevice()

which can be called as, e.g.,

ideal.GetOnDevice();

If you don’t want to use GPU’s you can ignore this.

You can then call the EOS. For example, to get pressure from density and temperature, just call (for example),

ideal.PressureFromDensityTemperature(rho, T);

The units are all in cgs. You can ignore the lambda for now.

Warning

When you’re done with the model, it’s good practice to release device memory with a call to

EOS::Finalize();

If you’re not using device memory, you can ignore this.

And that’s it!

Going Deeper

  • You can find code examples in the example source directory. We describe them here.

  • To learn more about the design philosophy, look here.

  • To learn about how to build, look at our build document.

  • To learn more about the equation of state API, look here.

  • To learn about the available equations of state, look here.

  • To learn about our mixed-cell closure models, such as pressure-temperature equilibrium, look at Mixed Cell Closures.

  • If you’re interested in contributing, check out our documentation for developers.