network.h

Go to the documentation of this file.

/* ***********************************************************************
//
//   Copyright (C) 2025 -- The 4D-STAR Collaboration
//   File Authors: Emily Boudreaux, Aaron Dotter
//   Last Modified: March 21, 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 <vector>
 
#include "fourdst/logging/logging.h"
#include "fourdst/config/config.h"
#include "fourdst/composition/species.h"
#include "fourdst/composition/composition.h"
#include "fourdst/constants/const.h"
 
#include "gridfire/reaction/reaction.h"
 
#include "quill/Logger.h"
 
#include <unordered_map>
 
 
namespace gridfire {
 
 
    enum NetworkFormat {
        APPROX8, 
        REACLIB, 
        UNKNOWN,
    };
 
    static inline std::unordered_map<NetworkFormat, std::string> FormatStringLookup = {
        {APPROX8, "Approx8"},
        {REACLIB, "REACLIB"},
        {UNKNOWN, "Unknown"}
    };
 
    struct NetIn {
        fourdst::composition::Composition composition; 
        double tMax; 
        double dt0; 
        double temperature; 
        double density; 
        double energy; 
        double culling = 0.0; 
 
        std::vector<double> MolarAbundance() const;
    };
 
    struct NetOut {
        fourdst::composition::Composition composition; 
        int num_steps; 
        double energy; 
 
        friend std::ostream& operator<<(std::ostream& os, const NetOut& netOut) {
            os << "NetOut(composition=" << netOut.composition << ", num_steps=" << netOut.num_steps << ", energy=" << netOut.energy << ")";
            return os;
        }
    };
 
    class Network {
        public:
            explicit Network(const NetworkFormat format = NetworkFormat::APPROX8);
            virtual ~Network() = default;
 
            [[nodiscard]] NetworkFormat getFormat() const;
            NetworkFormat setFormat(const NetworkFormat format);

            virtual NetOut evaluate(const NetIn &netIn) = 0;
 
            virtual bool isStiff() const { return m_stiff; }
            virtual void setStiff(const bool stiff) { m_stiff = stiff; }
 
        protected:
            fourdst::config::Config& m_config; 
            fourdst::logging::LogManager& m_logManager; 
            quill::Logger* m_logger; 
 
            NetworkFormat m_format; 
            fourdst::constant::Constants& m_constants;
 
            bool m_stiff = false; 
    };
 
 
    reaction::LogicalReactionSet build_reaclib_nuclear_network(const fourdst::composition::Composition &composition, bool reverse);
 
 
} // namespace nuclearNetwork