YAMLPhreeqcRM.h

Go to the documentation of this file.

#ifdef USE_YAML
#ifndef INC_YAMLPHREEQCRM_H
#define INC_YAMLPHREEQCRM_H
#include <map>
#include <mutex>
#include <string>
#include "yaml-cpp/yaml.h"
#include "IrmResult.h"
//#pragma once
 
#include "irm_dll_export.h"
 
class IRM_DLL_EXPORT YAMLPhreeqcRM
{
private:
    YAML::Node YAML_doc;
    std::map<std::string, int> method_map;
    YAML::EmitterStyle::value style;
protected:
    friend class YAMLPhreeqcRMLib;
    static std::map<size_t, YAMLPhreeqcRM*> Instances;
    static std::mutex InstancesLock;
    static size_t InstancesIndex;
    size_t Index;
public:
 
    YAMLPhreeqcRM();
    ~YAMLPhreeqcRM();
    void Clear();   
    int                      GetId(void)const;
    const YAML::Node& GetYAMLDoc() { return this->YAML_doc; };
    void WriteYAMLDoc(std::string file_name);
    // methods
    void YAMLAddOutputVars(std::string option, std::string def);
    void YAMLCloseFiles(void);
    void YAMLCreateMapping(std::vector< int >& grid2chem);
    void YAMLDumpModule(bool dump_on, bool append);
    void YAMLThreadCount(int nthreads);
    void YAMLFindComponents();
    void YAMLInitialSolutions2Module(std::vector< int > solutions);
    void YAMLInitialEquilibriumPhases2Module(std::vector< int > equilibrium_phases);
    void YAMLInitialExchanges2Module(std::vector< int > exchanges);
    void YAMLInitialSurfaces2Module(std::vector< int > surfaces);
    void YAMLInitialGasPhases2Module(std::vector< int > gas_phases);
    void YAMLInitialSolidSolutions2Module(std::vector< int > solid_solutions);
    void YAMLInitialKinetics2Module(std::vector< int > kinetics);
    void YAMLInitialPhreeqc2Module(std::vector< int > initial_conditions1);
    void YAMLInitialPhreeqc2Module(std::vector< int > initial_conditions1, std::vector< int > initial_conditions2, std::vector< double > fraction1);
    void YAMLInitialPhreeqcCell2Module(int n, std::vector< int > cell_numbers);
    void YAMLLoadDatabase(std::string database);
    void YAMLLogMessage(std::string str);
    void YAMLOpenFiles(void);
    void YAMLOutputMessage(std::string str);
    void YAMLRunCells(void);
    void YAMLRunFile(bool workers, bool initial_phreeqc, bool utility, std::string chemistry_name);
    void YAMLRunString(bool workers, bool initial_phreeqc, bool utility, std::string input_string);
    void YAMLScreenMessage(std::string str);
    void YAMLSetComponentH2O(bool tf);
    void YAMLSetConcentrations(std::vector< double >& c);
    void YAMLSetCurrentSelectedOutputUserNumber(int n_user);
    void YAMLSetDensityUser(std::vector< double > density);
    void YAMLSetDumpFileName(std::string dump_name);
    void YAMLSetErrorHandlerMode(int mode);
    void YAMLSetErrorOn(bool tf);
    void YAMLSetFilePrefix(std::string prefix);
    void YAMLSetGasCompMoles(std::vector< double > gas_moles);
    void YAMLSetGasPhaseVolume(std::vector< double > gas_volume);
    void YAMLSetGridCellCount(int n);
    void YAMLSetNthSelectedOutput(int n);
    void YAMLSetPartitionUZSolids(bool tf);
    void YAMLSetPorosity(std::vector< double > por);
    void YAMLSetPressure(std::vector< double > p);
    void YAMLSetPrintChemistryMask(std::vector< int > cell_mask);
    void YAMLSetPrintChemistryOn(bool workers, bool initial_phreeqc, bool utility);
    void YAMLSetRebalanceByCell(bool tf);
    void YAMLSetRebalanceFraction(double f);
    void YAMLSetRepresentativeVolume(std::vector< double > rv);
    void YAMLSetSaturationUser(std::vector< double > sat);
    void YAMLSetScreenOn(bool tf);
    void YAMLSetSelectedOutputOn(bool tf);
    void YAMLSetSpeciesSaveOn(bool save_on);
    void YAMLSetTemperature(std::vector< double > t);
    void YAMLSetTime(double time);
    void YAMLSetTimeConversion(double conv_factor);
    void YAMLSetTimeStep(double time_step);
    void YAMLSetUnitsExchange(int option);
    void YAMLSetUnitsGasPhase(int option);
    void YAMLSetUnitsKinetics(int option);
    void YAMLSetUnitsPPassemblage(int option);
    void YAMLSetUnitsSolution(int option);
    void YAMLSetUnitsSSassemblage(int option);
    void YAMLSetUnitsSurface(int option);
    void YAMLSpeciesConcentrations2Module(std::vector< double > species_conc);
    void YAMLStateSave(int istate);
    void YAMLStateApply(int istate);
    void YAMLStateDelete(int istate);
    void YAMLUseSolutionDensityVolume(bool tf);
    void YAMLWarningMessage(std::string warnstr);
    // data
 
};
#include "bmi.hxx"
class YAMLPhreeqcRMLib
{
public:
    //static void CleanupYAMLPhreeqcRMInstances(void);
    static int CreateYAMLPhreeqcRM(void);
    static IRM_RESULT DestroyYAMLPhreeqcRM(int n);
    static YAMLPhreeqcRM* GetInstance(int n);
};
 
#endif // INC_YAMLPHREEQCRM_H
#endif