geos::ConvergenceStatistics Class Reference

Class containing convergence information given a time-step. More...

#include <SolverStatistics.hpp>

Public Member Functions
	ConvergenceStatistics ()
	Construct a new Convergence Statistics object.
void	setCSVOutputRequest (bool state)
	Set the csv output state. Set this to true when a CSV output is requested. More...
bool	getCSVOutputRequest ()
bool	getCSVOutputOpened () const
void	writeConvergenceStatsToTable ()
	Write all the convergence statistics into the ouput stream.
void	updateSolverStep (real64 const &time_n, real64 const &dt, integer const cycleNumber, integer const newtonIter)
	Update the solver step with the time informations. More...
void	setResidualValue (string const &key, real64 const value)
	Set a residual value given a key ( column in the CSV ) More...
void	setFilename (string_view filename)
	Set the filename output file. More...
void	setTableName (string_view name)
	Set the filename output file. More...
string const &	getFilename () const
string &	getFilename ()
	A string reference to a convergence filename.
void	closeFile ()
	Close the stream output file if a file was created.

Detailed Description

Class containing convergence information given a time-step.

Definition at line 252 of file SolverStatistics.hpp.

Member Function Documentation

getCSVOutputOpened()

bool geos::ConvergenceStatistics::getCSVOutputOpened ( ) const

inline

Returns

true if the CSV statistics file has been opened for any effective output, false otherwise.

Definition at line 277 of file SolverStatistics.hpp.

getCSVOutputRequest()

bool geos::ConvergenceStatistics::getCSVOutputRequest ( )

inline

Returns

true if the CSV statistics file output is requested, false otherwise.

Definition at line 271 of file SolverStatistics.hpp.

getFilename()

string const& geos::ConvergenceStatistics::getFilename ( ) const

inline

Returns

A const string convergence filename

Definition at line 322 of file SolverStatistics.hpp.

setCSVOutputRequest()

void geos::ConvergenceStatistics::setCSVOutputRequest ( bool  state )

inline

Set the csv output state. Set this to true when a CSV output is requested.

Parameters

state

The CSV state for the corresponding statistics

Definition at line 265 of file SolverStatistics.hpp.

setFilename()

void geos::ConvergenceStatistics::setFilename ( string_view  filename )

inline

Set the filename output file.

Parameters

filename

The filename as a string_view.

Definition at line 309 of file SolverStatistics.hpp.

setResidualValue()

void geos::ConvergenceStatistics::setResidualValue ( string const &  key, real64 const  value  )

inline

Set a residual value given a key ( column in the CSV )

Parameters

key	The corresponding column
value	The residual value

Definition at line 302 of file SolverStatistics.hpp.

setTableName()

void geos::ConvergenceStatistics::setTableName ( string_view  name )

inline

Set the filename output file.

Parameters

filename

The filename as a string_view.

Definition at line 316 of file SolverStatistics.hpp.

updateSolverStep()

void geos::ConvergenceStatistics::updateSolverStep	(	real64 const &	time_n,
		real64 const &	dt,
		integer const	cycleNumber,
		integer const	newtonIter
	)

Update the solver step with the time informations.

Parameters

time_n	The time at the beginning of the step
dt	The desired timestep
cycleNumber	The current cycle number
iterNumber	The current iteration number

---

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

• coreComponents/physicsSolvers/SolverStatistics.hpp