unsaturated

stagger_structs.hpp
View Options

			#ifndef SPECMICP_REACTMICP_SOLVER_STAGGERSTRUCTS_HPP
			#define SPECMICP_REACTMICP_SOLVER_STAGGERSTRUCTS_HPP

			//! \file stagger_structs.hpp common structs for the staggers

			namespace specmicp {
			namespace reactmicp {
			namespace solver {

			//! \brief Return code error used by a stagger
			//!
			//! Success of the stagger should be tested as :
			//! return code > NotConvergedYet
			enum class StaggerReturnCode
			{
			LolThatsNotSupposedToHappen, //!< Mainly for debugging purposes
			UnknownError, //!< Generic error, when used, an entry in the log is necessary
			MaximumIterationsReached, //!< Maximum number of iterations reached in the code
			StationaryPoint, //!< Stagger is stuck in a Stationary point
			NotConvergedYet, //!< The stagger has not converged yet
			ResidualMinimized, //!< The residuals are minimized
			ErrorMinimized //!< The error is minimized
			};

			} // end namespace solver
			} // end namespace reactmicp
			} // end namespace specmicp

			#endif // SPECMICP_REACTMICP_SOLVER_STAGGERSTRUCTS_HPP