Homec4science
Diffusion SpecMiCP / ReactMiCP (chloride) Browse

specmicp/src/specmicp/adimensional/adimensional_system_solution_saver.hpp
e1d44a9d9d81chloride

Last Change
Raw File

adimensional_system_solution_saver.hpp
View Options

/*-------------------------------------------------------------------------------
Copyright (c) 2015 F. Georget <fabieng@princeton.edu>, Princeton University
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-----------------------------------------------------------------------------*/
#ifndef SPECMICP_SPECMICP_ADIMENSIONALSYSTEMSOLUTIONSAVER_HPP
#define SPECMICP_SPECMICP_ADIMENSIONALSYSTEMSOLUTIONSAVER_HPP
#include "../../types.hpp"
#include "../../database.hpp"
#include "adimensional_system_numbering.hpp"
#include <string>
namespace YAML {
class Node;
class Emitter;
} //end namespace YAML
namespace specmicp {
struct AdimensionalSystemSolution;
//! \brief This is a serializer for the AdimensionalSystemSolution
//!
//! This class format the solution is a JSON-formatted string.
class SPECMICP_DLL_PUBLIC AdimensionalSystemSolutionSaver : AdimemsionalSystemNumbering
{
public:
AdimensionalSystemSolutionSaver(const RawDatabasePtr& the_database):
AdimemsionalSystemNumbering(the_database)
{}
//! \brief Format the solution as a YAML-formatted string
std::string format_solution(const AdimensionalSystemSolution& solution);
//! \brief Save the solution as a YAML file
//!
//! \param filepath path the file where to solve the solution
//! \param solution the solution to save
void save_solution(
const std::string& filename,
const AdimensionalSystemSolution& solution
);
//! \brief Save a set of solutions as a YAML file
//!
//! \param filepath path to the file where to solve the solutions
//! \param solutions vector of solutions
void save_solutions(
const std::string& filepath,
const std::vector<AdimensionalSystemSolution>& solutions
);
//! \brief Create a solution from a YAML input
AdimensionalSystemSolution parse_solution(std::istream& input);
//! \brief Create a solution from a YAML file
AdimensionalSystemSolution parse_solution(const std::string& filename);
//! \brief Create a solution from a YAML file
void parse_solutions(const std::string& filename,
std::vector<AdimensionalSystemSolution>& solutions_vector);
private:
//! \brief Build the Json::Value tree corresponding to the solution (+metadata)
void SPECMICP_DLL_LOCAL set_yaml_emitter(
const AdimensionalSystemSolution& solution,
YAML::Emitter& yaml_tree
);
//! \brief Build the Json::Value tree corresponding to the solution (w/o metadata)
void SPECMICP_DLL_LOCAL format_solution(
const AdimensionalSystemSolution& solution,
YAML::Emitter& out
);
//! \brief Format the main variables
void SPECMICP_DLL_LOCAL format_main_variables(
const AdimensionalSystemSolution& solution,
YAML::Emitter& out
);
//! \brief Format the main variables
void SPECMICP_DLL_LOCAL format_aqueous_molalities(
const AdimensionalSystemSolution& solution,
YAML::Emitter& out
);
//! \brief Format the log of activity coefficients
void SPECMICP_DLL_LOCAL format_loggamma(
const AdimensionalSystemSolution& solution,
YAML::Emitter& out
);
//! \brief Format the gas fugacities
void SPECMICP_DLL_LOCAL format_gas_fugacities(
const AdimensionalSystemSolution& solution,
YAML::Emitter& out
);
//! \brief Format the sorbed molalities
void SPECMICP_DLL_LOCAL format_sorbed_molalities(
const AdimensionalSystemSolution& solution,
YAML::Emitter& out
);
//! \brief Check the metatada : issue warnings if the metadata does not look correct
int SPECMICP_DLL_LOCAL parse_check_metadata(const YAML::Node& root);
//! \brief Parse one solution from the JSON tree
void SPECMICP_DLL_LOCAL parse_one_solution(
const YAML::Node& yaml_solution,
AdimensionalSystemSolution& the_solution
);
//! \brief Parse the main variables
void SPECMICP_DLL_LOCAL read_main_variables(
const YAML::Node& root,
AdimensionalSystemSolution& solution
);
//! \brief Parse the activity coefficients
void SPECMICP_DLL_LOCAL read_aqueous_molalities(
const YAML::Node& root,
AdimensionalSystemSolution& solution
);
//! \brief Parse the activity coefficients
void SPECMICP_DLL_LOCAL read_loggamma(
const YAML::Node& root,
AdimensionalSystemSolution& solution
);
//! \brief Parse the gas fugacities
void SPECMICP_DLL_LOCAL read_gas_fugacities(
const YAML::Node& root,
AdimensionalSystemSolution& solution
);
//! \brief Parsed the sorbed molalities
void SPECMICP_DLL_LOCAL read_sorbed_molalities(
const YAML::Node& root,
AdimensionalSystemSolution& solution
);
};
//! \brief Serialize a solution as a JSON-formatted string
std::string
SPECMICP_DLL_PUBLIC
format_solution_yaml(
const RawDatabasePtr& the_database,
const AdimensionalSystemSolution& the_solution
);
//! \brief Serialize a solution and save it in a file
void
SPECMICP_DLL_PUBLIC
save_solution_yaml(
const std::string& filename,
const RawDatabasePtr& the_database,
const AdimensionalSystemSolution& the_solution
);
//! \brief Read a solution from a JSON file
AdimensionalSystemSolution
SPECMICP_DLL_PUBLIC
parse_solution_yaml(
const std::string& filename,
const RawDatabasePtr& the_database
);
//! \brief Read a solution from a JSON file
AdimensionalSystemSolution
SPECMICP_DLL_PUBLIC
parse_solution_yaml(
std::istream& input,
const RawDatabasePtr& the_database
);
} //end namespace specmicp
#endif // SPECMICP_SPECMICP_ADIMENSIONALSYSTEMSOLUTIONSAVER_HPP
c4science · Help