unsaturated

reactive_transport_solver_structs.hpp
View Options

			#ifndef SPECMICP_REACTMICP_SOLVER_REACTIVETRANSPORTSOLVERSTRUCTS_HPP
			#define SPECMICP_REACTMICP_SOLVER_REACTIVETRANSPORTSOLVERSTRUCTS_HPP

			#include "common.hpp"

			namespace specmicp {
			namespace reactmicp {
			namespace solver {

			enum class ReactiveTransportReturnCode
			{
			UpscalingFailure = -13,
			ChemistryFailure = -12,
			TransportFailure = -11,
			StaggerFailure = -10,
			MaximumIterationsReached = - 2,
			StationaryPoint = - 1,
			NotConvergedYet = 0,
			ResidualMinimized = 1,
			ErrorMinimized = 2
			};

			struct ReactiveTransportOptions
			{
			scalar_t residuals_tolerance;
			scalar_t absolute_residuals_tolerance;
			scalar_t step_tolerance;
			scalar_t good_enough_tolerance;
			index_t maximum_iterations;
			bool implicit_upscaling;

			bool is_snia() {return maximum_iterations <= 1;}

			ReactiveTransportOptions():
			residuals_tolerance(1e-4),
			absolute_residuals_tolerance(1e-16),
			step_tolerance(1e-10),
			good_enough_tolerance(1e-2),
			maximum_iterations(100),
			implicit_upscaling(false)
			{}
			};

			struct ReactiveTransportPerformance
			{
			index_t nb_iterations;
			ReactiveTransportReturnCode return_code;
			scalar_t residuals;
			};


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

			#endif // SPECMICP_REACTMICP_SOLVER_REACTIVETRANSPORTSOLVERSTRUCTS_HPP