Homec4science
Diffusion SpecMiCP / ReactMiCP (master) Browse

specmicp/src/reactmicp/systems/single/chemistry_program.hpp
b2c071e32a99master

Last Change
Raw File

chemistry_program.hpp
View Options

/* =============================================================================
Copyright (c)
2014-2017 F. Georget <fabieng@princeton.edu> Princeton University
2017-2021 F. Georget <fabien.georget@epfl.ch> EPFL
2021- F. Georget <georget@ibac.rwth-aachen.de> RWTH Aachen
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_REACTMICP_SYSTEMS_SINGLE_CHEMISTRYPROGRAM_HPP
#define SPECMICP_REACTMICP_SYSTEMS_SINGLE_CHEMISTRYPROGRAM_HPP
#include "specmicp_common/types.hpp"
#include "specmicp_common/return_code.hpp"
#include "variablesfwd.hpp"
#include <functional>
namespace specmicp {
namespace reactmicp {
namespace systems {
namespace single {
struct ChemistryProgramReturn
{
ReturnCode retcode;
// only assume that we get the concentration (i.e. case of equilibrium stagger)
scalar_t fluid_concentration;
scalar_t bound_concentration;
};
class ChemistryProgram
{
public:
ChemistryProgram() {}
virtual ChemistryProgramReturn solve_one_node(index_t node, scalar_t dt, SingleVariables * const var) =0;
};
using rate_f = std::function<scalar_t (index_t, scalar_t, SingleVariables * const)>;
class DefaultChemistryProgram:
public ChemistryProgram
{
public:
DefaultChemistryProgram(rate_f rate_function):
m_rate_function(rate_function)
{}
virtual ChemistryProgramReturn solve_one_node(index_t node, scalar_t dt, SingleVariables * const var) override;
private:
rate_f m_rate_function;
};
} // end namespace single
} // end namespace systems
} // end namespace reactmicp
} // end namespace specmicp
#endif // SPECMICP_REACTMICP_SYSTEMS_SINGLE_CHEMISTRYPROGRAM_HPP
c4science · Help