SpECTRE  v2024.04.12
h5::StellarCollapseEos Class Reference

Reads in tabulated equation of state file from stellarcollapse.org More...

#include <StellarCollapseEos.hpp>

Public Member Functions

template<typename T >
get_scalar_dataset (const std::string &dataset_name) const
 reads a rank-0 dataset (contains only one element)
 
std::vector< double > get_rank1_dataset (const std::string &dataset_name) const
 reads a dataset with elements along 1 dimension
 
boost::multi_array< double, 3 > get_rank3_dataset (const std::string &dataset_name) const
 reads a dataset with elements along 3 dimensions
 
const std::stringsubfile_path () const override
 Return the path to the subfile where this object is stored. More...
 
virtual const std::stringsubfile_path () const =0
 Return the path to the subfile where this object is stored. More...
 

Detailed Description

Reads in tabulated equation of state file from stellarcollapse.org

Reads in H5 file containing data for tabulated equation of state. Contains functions to obtain thermodynamic quantities from the file, stored as either rank-1 or rank-3 datasets.

It is assumed that the file is in the format of the SRO (Schneider, Roberts, Ott 2017) Equation of State files

The description of each dataset in the file can be found here

Member Function Documentation

◆ subfile_path()

const std::string & h5::StellarCollapseEos::subfile_path ( ) const
inlineoverridevirtual

Return the path to the subfile where this object is stored.

Implements h5::Object.


The documentation for this class was generated from the following file: