Homec4science
Diffusion SpecMiCP / ReactMiCP (chloride) Browse

specmicp/src/utils/io/reactive_transport.hpp
f2a40262416bchloride

Last Change
Raw File

reactive_transport.hpp
View Options

#ifndef SPECMICP_IO_REACTMICP_HPP
#define SPECMICP_IO_REACTMICP_HPP
#include <iostream>
#include "reactmicp/solver/reactive_transport_solver_structs.hpp"
namespace specmicp {
namespace io {
//! \brief Print the header
inline void print_reactmicp_header(
std::ostream* output
);
//! \brief Print the performance information of the reactive transport solver
inline void print_reactmicp_performance_short(
std::ostream* output,
const reactmicp::solver::ReactiveTransportPerformance& perf
);
//! \brief Print the timing information of the reactive transport solver
inline void print_reactmicp_timer(
std::ostream* output,
const reactmicp::solver::ReactiveTransportTimer& timer
);
//! \brief Return a literal version of a ReactiveTransportReturnCode
inline std::string reactmicp_return_code_to_string(
reactmicp::solver::ReactiveTransportReturnCode retcode);
inline void print_reactmicp_header(
std::ostream* output
)
{
(*output) << "// ================================== //\n"
<< "// //\n"
<< "// ReactMiCP //\n"
<< "// //\n"
<< "// ================================== //\n\n"
<< "A reactive transport solver based on SpecMiCP.\n"
<< "------------------------------------------- \n"
<< std::endl;
}
inline void print_reactmicp_performance_short(
std::ostream* output,
const reactmicp::solver::ReactiveTransportPerformance& perf
)
{
(*output) << "------------------------------------------- \n"
<< " Performance \n "
<< "------------------------------------------- \n\t"
<< " - Return code : " << reactmicp_return_code_to_string(perf.return_code) << "\n\t"
<< " - Residuals : " << perf.residuals << "\n\t"
<< " - Number of iterations : " << perf.nb_iterations << "\n"
<< "------------------------------------------- " << std::endl;
}
inline void print_reactmicp_timer(
std::ostream* output,
const reactmicp::solver::ReactiveTransportTimer& timer
)
{
(*output) << "------------------------------------------- \n"
<< "Time spend in each stagger \n"
<< "------------------------------------------- \n\t"
<< "- Transport : " << timer.transport_time << " s\n\t"
<< "- Chemistry : " << timer.chemistry_time << " s\n\t"
<< "- Upscaling : " << timer.upscaling_time << " s\n"
<< "-----------------------------------------" << std::endl;
}
inline void print_reactmicp_performance_long_header(
std::ostream* output
)
{
(*output) << "Id\t T\t dt\t Return_code\t Iterations \t Residuals\t Time\t Transport_time\t Chemistry_time"
<< std::endl;
}
inline void print_reactmicp_performance_long(
std::ostream* output,
index_t cnt,
scalar_t total,
const reactmicp::solver::ReactiveTransportPerformance& perfs
)
{
(*output) << cnt << "\t "
<< total << "\t "
<< perfs.timestep << "\t "
<< (int) perfs.return_code << "\t "
<< perfs.nb_iterations << "\t "
<< perfs.residuals << "\t "
<< perfs.total_time << "\t"
<< perfs.transport_time << "\t"
<< perfs.chemistry_time
<< std::endl;
}
inline std::string reactmicp_return_code_to_string(
reactmicp::solver::ReactiveTransportReturnCode retcode)
{
using RetCode = reactmicp::solver::ReactiveTransportReturnCode;
switch (retcode) {
case RetCode::ResidualMinimized:
return "ResidualMinimized";
case RetCode::ErrorMinimized:
return "ErrorMinimized";
default:
switch (retcode) {
case RetCode::StationaryPoint:
return "StationaryPoint";
case RetCode::MaximumIterationsReached:
return "MaximumIterationsReached";
case RetCode::TransportFailure:
return "TransportFailure";
case RetCode::ChemistryFailure:
return "ChemistryFailure";
case RetCode::UpscalingFailure:
return "UpscalingFailure";
default:
return "Unknow error code !";
}
}
}
} // end namespace io
} // end namespace specmicp
#endif // SPECMICP_IO_REACTMICP_HPP
c4science · Help