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	setCSVOutputState (bool state)
	Set the csv state output. More...
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)
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.

Public Attributes
bool	m_csvOutputEnabled = false
	State of csv output. True when writeSolver is set to 2.

Detailed Description

Class containing convergence information given a time-step.

Definition at line 240 of file SolverStatistics.hpp.

Member Function Documentation

getFilename()

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

inline

Returns

A const convergence filename

Definition at line 296 of file SolverStatistics.hpp.

setCSVOutputState()

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

inline

Set the csv state output.

Parameters

state

csv state

Definition at line 256 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 283 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 290 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