Homec4science
Diffusion SpecMiCP / ReactMiCP (master) Browse

specmicp/src/specmicp_database/aqueous_selector.hpp
4728ae8e7325master

Last Change
Raw File

aqueous_selector.hpp
View Options

/* =============================================================================
Copyright (c) 2014 - 2016
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_DATABASE_AQUEOUSSELECTOR_HPP
#define SPECMICP_DATABASE_AQUEOUSSELECTOR_HPP
//! \file aqueous_selector.hpp
//! \brief Select aqueous in the database
#include "module.hpp"
namespace specmicp {
namespace database {
//! \class AqueousSelector
//! \brief Select aqueous in the database
//!
//! Remove aqueous species from the database.
//! This should not be used normally but may be necessary in
//! artificial problem. (e.g. the MoMas benchmark)
class SPECMICP_DLL_PUBLIC AqueousSelector: public DatabaseModule
{
public:
//! \brief Constructor
AqueousSelector(RawDatabasePtr thedata):
DatabaseModule(thedata)
{}
//! \brief Remove some specific aqueous species
//!
//! \param id_aqueous vector containing the if of the species to remove
void remove_aqueous(const std::vector<index_t>& id_aqueous);
};
} // end namespace database
} // end namespace specmicp
#endif // SPECMICP_DATABASE_AQUEOUSSELECTOR_HPP
c4science · Help