Homec4science
Diffusion SpecMiCP / ReactMiCP (reactivetransport) Browse

specmicp/src/specmicp/reaction_path.hpp
583c1a0f5574reactivetransport

Last Change
Raw File

reaction_path.hpp
View Options

/*-------------------------------------------------------
- Module : specmicp
- File : reaction_path.hpp
- Author : Fabien Georget
Copyright (c) 2014, Fabien Georget, Princeton University
---------------------------------------------------------*/
#ifndef SPECMICP_SPECMICP_REACTIONPATH_HPP
#define SPECMICP_SPECMICP_REACTIONPATH_HPP
//! \file reaction_path.hpp reaction path driver
#include <memory>
#include <map>
#include "database/database.hpp"
#include "micpsolver/micpsolver_structs.hpp"
#include "reduced_system_solver.hpp"
#include "equilibrium_data.hpp"
namespace specmicp {
//! \brief typedef to a reaction path amount
//!
//! The first element is the inital amount,
//! The second element is the increase to add at every step
using reaction_amount_t = std::pair<double, double>;
//! \brief A reaction path model
//!
//! Contains every data we need to run a reaction path model
struct ReactionPathModel
{
//! The amount of components
std::map<std::string, reaction_amount_t> amount_aqueous;
//! The amount of minerals
std::map<std::string, reaction_amount_t> amount_minerals;
//! List of minerals to take into account
std::vector<std::string> minerals_to_keep;
//! the number of step
int nb_step;
//! the path to the database - optional
std::string database_path;
};
//! \brief Driver to solve a reaction path model
class ReactionPathDriver
{
public:
//! \brief Initialise from a model
//!
//! Build a database from the attribute database_path of the model
ReactionPathDriver(std::shared_ptr<ReactionPathModel> model,
ReducedSystemSolverOptions options=ReducedSystemSolverOptions()):
m_model(model),
m_solver_options(options)
{
read_database();
}
//! \brief Initialise the driver from a model and a raw database
ReactionPathDriver(std::shared_ptr<ReactionPathModel> model,
std::shared_ptr<database::DataContainer> data,
ReducedSystemSolverOptions options=ReducedSystemSolverOptions()):
m_model(model),
m_database(data),
m_data(data),
m_solver_options(options)
{}
//! Initialize the database
void read_database();
//! Dissolve everything into components
void dissolve_to_components();
//! \brief Perform one step
micpsolver::MiCPPerformance one_step(Eigen::VectorXd& x, bool init=false);
//! \brief run all steps
void run_all();
EquilibriumState get_current_solution() const {return m_current_solution;}
const ReducedSystemSolverOptions& get_options() const {return m_solver_options;}
ReducedSystemSolverOptions& get_options() {return m_solver_options;}
private:
std::shared_ptr<ReactionPathModel> m_model;
specmicp::database::Database m_database;
std::shared_ptr<specmicp::database::DataContainer> m_data;
Eigen::VectorXd m_tot_conc;
Eigen::VectorXd m_tot_conc_increase;
ReducedSystemSolverOptions m_solver_options;
EquilibriumState m_current_solution;
//std::shared_ptr<ThermoData> m_thermo;
};
} // end namespace specmicp
#endif // SPECMICP_SPECMICP_REACTIONPATH_HPP
c4science · Help