Homec4science
Diffusion SpecMiCP / ReactMiCP (chloride) Browse

specmicp/src/specmicp/adimensional/adimensional_system_pcfm_structs.hpp
e1d44a9d9d81chloride

Last Change
Raw File

adimensional_system_pcfm_structs.hpp
View Options

/*-------------------------------------------------------------------------------
Copyright (c) 2014,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_ADIMENSIONALSYSTEMPCFMSTRUCTS_HPP
#define SPECMICP_ADIMENSIONALSYSTEMPCFMSTRUCTS_HPP
#include "../../types.hpp"
//! \file adimensional_system_pcfm_structs.hpp
//! \brief Enum and structs used by the pcfm solver
//! \sa specmicp::AdimensionalSystemPCFM
namespace specmicp {
//! \enum PCFMReturnCode
//! \brief The return codes for the positive continuous fraction method
//! \sa specmicp::AdimensionalSystemPCFM
enum class PCFMReturnCode
{
LolThatsNotSupposedToHappen, //! Bummer...
Error, //!< Some kind of error happended
MaxIterationsReached, //!< The maximum number of iterations was reached
NotConvergedYet, //!< The problem has not converged yet
Success //!< Success !
};
//! \struct PCFMOptions
//! \brief Options for the Positive continuous fraction method
//! \sa specmicp::AdimensionalSystemPCFM
struct PCFMOptions
{
index_t max_iterations; //!< The maximum number of iterations
scalar_t tolerance; //!< The tolerance (should be relatively high around 0.5)
scalar_t theta_factor; //!< multiplicatif factor for theta
PCFMOptions():
max_iterations(100),
tolerance(0.5),
theta_factor(0.25)
{}
};
} // end namespace specmicp
#endif
c4science · Help