EOSio.h

Go to the documentation of this file.

/* ***********************************************************************
//
//   Copyright (C) 2025 -- The 4D-STAR Collaboration
//   File Author: Emily Boudreaux
//   Last Modified: March 20, 2025
//
//   4DSSE is free software; you can use it and/or modify
//   it under the terms and restrictions the GNU General Library Public
//   License version 3 (GPLv3) as published by the Free Software Foundation.
//
//   4DSSE is distributed in the hope that it will be useful,
//   but WITHOUT ANY WARRANTY; without even the implied warranty of
//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//   See the GNU Library General Public License for more details.
//
//   You should have received a copy of the GNU Library General Public License
//   along with this software; if not, write to the Free Software
//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
// *********************************************************************** */
#pragma once
#include <string>
#include <variant>
#include <memory>
#include <unordered_map>
#include "helm.h"
 
namespace serif::eos {
    enum EOSFormat {
        HELM, 
    };
 
    static inline std::unordered_map<EOSFormat, std::string> FormatStringLookup = {
    {HELM, "Helmholtz"}
    };
    // EOS table format includes
 
    using EOSTable = std::variant<std::unique_ptr<serif::eos::helmholtz::HELMTable>>;

    class EOSio {
    private:
        std::string m_filename; 
        bool m_loaded = false; 
        EOSFormat m_format;
        EOSTable m_table; 

        void load();

        void loadHelm();
    public:
        explicit EOSio(const std::string &filename, EOSFormat format = EOSFormat::HELM);

        EOSio(const EOSio& other);

        ~EOSio() = default;

        [[nodiscard]] std::string getFormatName() const;
 
        [[nodiscard]] EOSFormat getFormat() const;

        [[nodiscard]] EOSTable& getTable();
 
        [[nodiscard]] std::string getFilename() const { return m_filename; }
 
        bool isLoaded() const { return m_loaded; }
    };
}