Homec4science
Diffusion SpecMiCP / ReactMiCP (database) Browse

specmicp/src/database/canonicalizer.hpp
29b3278d5651database

Last Change
Raw File

canonicalizer.hpp
View Options

/*-------------------------------------------------------
- Module : database
- File : canonicalizer
- 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_CANONICALIZER
#define SPECMICP_DATABASE_CANONICALIZER
//! \file canonicalizer.hpp Transform a database into canonical form
#include "module.hpp"
namespace specmicp {
namespace database {
//! \brief Transform a database into canonical form
//!
//! Canonical form means that every secondary species are written as function of the components
//!
//! P.S : what a great name
class DatabaseCanonicalizer: public DatabaseModule
{
public:
DatabaseCanonicalizer(RawDatabasePtr thedata):
DatabaseModule(thedata)
{}
//! \brief Transform the database into canonical form
//!
//! This process is necessary before any computation
void make_canonical();
private:
//! \brief transform the aqueous system into a canonical form
void make_aqueous_canonical();
//! \brief transform the mineral system into a canonical form
void make_mineral_canonical();
//! \brief transform the mineral (governed by kineticS) system into a canonical form
void make_mineral_kinetic_canonical();
//! \brief transform the gas system into a canonical form
void make_gas_canonical();
};
//! Set the database to canonical form
inline void canonicalize_database(RawDatabasePtr data)
{
DatabaseCanonicalizer(data).make_canonical();
}
} // end namespace database
} // end namespace specmicp
#endif // SPECMICP_DATABASE_CANONICALIZER
c4science · Help