Homec4science
Diffusion SpecMiCP / ReactMiCP (kinetics) Browse

specmicp/src/database/common_def.hpp
9a4089e18a62kinetics

Last Change
Raw File

common_def.hpp
View Options

/*-------------------------------------------------------
- Module : database
- File : common_def.hpp
- Author : Fabien Georget
Copyright (c) 2014, Fabien 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:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* 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.
* Neither the name of the Princeton University 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 OWNER 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_DATABASE_COMMONDEF_HPP
#define SPECMICP_DATABASE_COMMONDEF_HPP
#include <vector>
#include <Eigen/Core>
#include <stdexcept>
#include "common.hpp"
//! \file common_def.hpp common type definitions
namespace specmicp {
namespace database {
//! Stability class of a mineral
enum class MineralStabilityClass
{
equilibrium,
cannot_dissolve,
cannot_precipitate
};
//! ID of a species
using id_species_t = index_t;
//! Vector containing a list of species (by ID)
using list_species_t = std::vector<id_species_t>;
//! Vector containing each strings
using vector_labels_t = std::vector<std::string>;
//! Stoechiometric coefficients for the reactions
using reaction_mat_t = Matrix;
//! Vector containing logK values
using logK_vector_t = Vector;
//! Vector containing molar masses
using data_vector_t = Vector;
//! std::Vector containing th mineral stability class
using list_stability_t = std::vector<MineralStabilityClass>;
// Error used when parsing and handling the database
// -------------------------------------------------
//! \brief This error is thrown when a bad syntax is detected in the database
class db_invalid_syntax : public std::invalid_argument
{
public:
db_invalid_syntax (const std::string &msg):
std::invalid_argument("Invalid syntax : " + msg)
{}
};
//! \brief This error is thrown when a bad syntax is detected in the database
class db_invalid_data : public std::invalid_argument
{
public:
db_invalid_data (const std::string &msg):
std::invalid_argument("Invalid syntax : " + msg)
{}
};
//! \brief This error is thrown when the database is not as expected
class invalid_database : public std::invalid_argument
{
public:
invalid_database (const std::string &msg):
std::invalid_argument("Invalid Database : " + msg)
{}
};
//! \brief This error is thrown when a non initialised value is wanted
class db_noninitialized_value : public std::runtime_error
{
public:
db_noninitialized_value (const std::string &value, const std::string &species):
std::runtime_error("Value was not initialized : " + value +", for species : "+species+".")
{}
};
} // end namespace database
} // end namespace specmicp
#endif // SPECMICP_DATABASE_COMMONDEF_HPP
c4science · Help