Inheritance diagram for CWindowedAverage:

Public Member Functions
	CWindowedAverage (WINDOW_FUNCTION windowId)
	Creates a new CWindowedAverage with the specified windowing function.

su2double	GetVal () const
	Returns the value of windowed-time average (of the instantaneous output) from starting time to the current time iteration.

void	Reset ()
	Resets the value of windowed-time average (of the instantaneous output) from starting time to the current time iteration to 0.

void	AddValue (su2double valIn, unsigned long curTimeIter, unsigned long startIter=0)
	Adds the instantaneous output of the current iteration to the values-vector, if the current iteration is greater or equal to the starting iteration.

Constructor & Destructor Documentation

◆ CWindowedAverage()

CWindowedAverage::CWindowedAverage ( WINDOW_FUNCTION windowId )

inlineexplicit

Creates a new CWindowedAverage with the specified windowing function.

void CWindowedAverage::AddValue	(	su2double	valIn,
		unsigned long	curTimeIter,
		unsigned long	startIter = `0`
	)

Adds the instantaneous output of the current iteration to the values-vector, if the current iteration is greater or equal to the starting iteration.

Parameters

valIn	- value of the instantaneous output, that should be added
currentIter	- current time Iteration
startIter	- iteration to start the windowed-time average.

su2double CWindowedAverage::GetVal ( ) const

inline

Returns the value of windowed-time average (of the instantaneous output) from starting time to the current time iteration.

void CWindowedAverage::Reset ( )

inline

Resets the value of windowed-time average (of the instantaneous output) from starting time to the current time iteration to 0.

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