hexed::Iteration_status Class Reference

Contains high-level diagnostic information about the status of a time-marching scheme. More...

#include <Iteration_status.hpp>

Public Member Functions
std::string	header ()
std::string	report ()
	return string containing numerical data separated by sep
void	set_time ()
	sets start_time() to now
double	start_time ()
	Unix epoch time that set_time was called.
double	wall_time ()
	wall clock time since start_time()

Public Attributes
data storage
User can overwrite – this class is just a container
double	flow_time = 0.
double	mmtm_res = 0
double	mass_res = 0
double	ener_res = 0
double	adv_res = 0
double	diff_res = 0
double	time_step = 0.
int	iteration = 0
int	fix_admis_iters = 0

Protected Member Functions
int	width ()
template<typename T >
std::string	format (std::string after, T value)

overrideable members
User can implement custom printing functionality by overriding the following members
std::string	sep = ", "
int	number_width = 15
	numbers will be justified to fit in columns of this width. Should be >= maximum width of formatted numbers
std::string	double_format = ".8e"
std::vector< std::string >	labels
	label of each column to print
virtual std::string	value_string ()

Detailed Description

Contains high-level diagnostic information about the status of a time-marching scheme.

More precisely, it contains single numbers (as opposed to field or mesh-dependent data) which characterize the progress of the iteration. Since much of this data is of immediate interest to the end user, this class can provide a text report formatted to be readable both by a human from the console and by a CSV parser from a file.

Member Function Documentation

header()

std::string hexed::Iteration_status::header

(

)

return string containing the column labels separated by sep, justified to align with numerical data in report().

value_string()

std::string hexed::Iteration_status::value_string ( )

protectedvirtual

return a string containing the data for each column followed by sep

Member Data Documentation

labels

std::vector<std::string> hexed::Iteration_status::labels

protected

Initial value:

{"iteration", "momtm resid", "mass resid", "energy resid", "av adv resid", "av diff resid",
                                   "flow time", "time step", "fix adm iters"}

label of each column to print

sep

std::string hexed::Iteration_status::sep = ", "

protected

string used to separate columns

---

The documentation for this class was generated from the following files:

• /home/micaiah/Desktop/hexed/include/Iteration_status.hpp
• /home/micaiah/Desktop/hexed/libhexed/Iteration_status.cpp