Base class that computes the ensemble- or time-based singular-value average values, with optional windowing, from the output of function objects that generate non-field type values, e.g. Cd of forceCoeffs or momentum_x in momentum function objects. More...

#include <valueAverageBase.H>

Inheritance diagram for valueAverageBase:

[legend]

Collaboration diagram for valueAverageBase:

[legend]

Public Types
enum class	windowType : uint8_t { NONE , APPROXIMATE , EXACT }
	Averaging window types. More...

Public Member Functions
	valueAverageBase (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state, const bool writeToFile=true)
	Construct from Time and dictionary.
	valueAverageBase (const valueAverageBase &)=delete
	No copy construct.
void	operator= (const valueAverageBase &)=delete
	No copy assignment.
virtual	~valueAverageBase ()=default
	Destructor.
virtual bool	read (const dictionary &dict)
	Read the field value average data.
virtual bool	calculate (dictionary &dict)
	Calculate the averages.
Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName.
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName and read options from dictionary.
	writeFile (const writeFile &wf)
	Construct copy.
virtual	~writeFile ()=default
	Destructor.
virtual const string &	setExt (const string &ext)
	Set extension.
virtual OFstream &	file ()
	Return access to the file (if only 1).
virtual bool	writeToFile () const
	Flag to allow writing to file.
virtual bool	canWriteToFile () const
	Flag to allow writing to the file.
virtual bool	canResetFile () const
	Flag to allow resetting the file.
virtual bool	canWriteHeader () const
	Flag to allow writing the header.
virtual label	charWidth () const
	Return width of character stream output.
virtual void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream.
virtual void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream.
virtual void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream.
virtual void	writeCurrentTime (Ostream &os) const
	Write the current time to stream.
virtual void	writeBreak (Ostream &os) const
	Write a break marker to the stream.
template<class Type>
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const
	Write a (commented) header property and value pair.
template<class Type>
void	writeValue (Ostream &os, const Type &val) const
	Write a given value to stream with the space delimiter.

Static Public Attributes
static const Enum< windowType >	windowTypeNames
	Names for windowType enumeration.
Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing.

Protected Member Functions
template<class Type, class Type2 = Type>
bool	calc (const label fieldi, bool &converged, dictionary &dict)
	Templated function to calculate the average.
virtual void	writeFileHeader (Ostream &os) const
	Output file header information.
virtual void	readState (dictionary &dict)
	Read state from dictionary.
virtual void	writeState (dictionary &dict)
	Write state to dictionary for restarts.
virtual void	resetState (dictionary &dict)
	Reset state.
Protected Member Functions inherited from writeFile
void	initStream (Ostream &os) const
	Initialise the output stream for writing.
fileName	baseFileDir () const
	Return the base directory for output.
fileName	baseTimeDir () const
	Return the base directory for the current time value.
fileName	filePath (const fileName &fName) const
	Return the full path for the supplied file name.
virtual autoPtr< OFstream >	newFile (const fileName &fName) const
	Return autoPtr to a new file using file name.
virtual autoPtr< OFstream >	newFileAtTime (const word &name, scalar timeValue) const
	Return autoPtr to a new file for a given time.
virtual autoPtr< OFstream >	newFileAtStartTime (const word &name) const
	Return autoPtr to a new file using the simulation start time.
virtual void	resetFile (const word &name)
	Reset internal file pointer to new file with new name.
Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset.
void	operator= (const writeFile &)=delete
	No copy assignment.
virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
	Deprecated(2022-09) Return autoPtr to a new file for a given time.
virtual autoPtr< OFstream >	createFile (const word &name) const
	Deprecated(2022-09) Return autoPtr to a new file using the simulation start time.

Protected Attributes
bool	resetOnRestart_
	Reset the averaging process on restart.
windowType	windowType_
	Window type.
stateFunctionObject &	state_
	Reference to the state functionObject.
word	functionObjectName_
	Name of function object to retrieve data from.
wordList	fieldNames_
	List of fields on which to operate.
scalar	tolerance_
	Optional tolerance to check for converged results.
scalar	window_
	Averaging window.
List< scalar >	totalTime_
	Average time per field.
Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry.
const fileName	prefix_
	Prefix.
word	fileName_
	Name of file.
autoPtr< OFstream >	filePtr_
	File pointer.
label	writePrecision_
	Write precision.
bool	writeToFile_
	Flag to enable/disable writing to file.
bool	updateHeader_
	Flag to update the header, e.g. on mesh changes. Default is true.
bool	writtenHeader_
	Flag to identify whether the header has been written.
bool	useUserTime_
	Flag to use the specified user time, e.g. CA deg instead of seconds. Default = true.
scalar	startTime_
	Start time value.
string	ext_
	File extension; default = .dat.

Detailed Description

Base class that computes the ensemble- or time-based singular-value average values, with optional windowing, from the output of function objects that generate non-field type values, e.g. Cd of forceCoeffs or momentum_x in momentum function objects.

See also

Foam::functionObjects::writeFile

Source files

Definition at line 58 of file valueAverageBase.H.

Member Enumeration Documentation

◆ windowType

enum class windowType : uint8_t

strong

Averaging window types.

Enumerator
NONE	"none"
APPROXIMATE	"approximate"
EXACT	"exact"

Definition at line 69 of file valueAverageBase.H.

Constructor & Destructor Documentation

◆ valueAverageBase() [1/2]

valueAverageBase	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		stateFunctionObject &	state,
		const bool	writeToFile = true )