Structure to store information for a history output field. More...

#include <COutput.hpp>

Public Member Functions
	HistoryOutputField ()
	Default constructor.

	HistoryOutputField (string fieldName_, ScreenOutputFormat screenFormat_, string OutputGroup_, HistoryFieldType fieldType_, string description_)
	Constructor to initialize all members.

Public Attributes
string	fieldName = ""
	The name of the field, i.e. the name that is printed in the screen or file header.

su2double	value = 0.0
	The value of the field.

ScreenOutputFormat	screenFormat = ScreenOutputFormat::FIXED
	The format that is used to print this value to screen.

string	outputGroup =""
	The group this field belongs to.

HistoryFieldType	fieldType = HistoryFieldType::DEFAULT
	The field type.

string	description = ""
	String containing the description of the field.

Detailed Description

Structure to store information for a history output field.

The stored information is printed to the history file and to screen. Each individual instance represents a single field (i.e. column) in the history file or on screen.

Constructor & Destructor Documentation

◆ HistoryOutputField() [1/2]

COutput::HistoryOutputField::HistoryOutputField ( )

inline

Default constructor.

◆ HistoryOutputField() [2/2]

COutput::HistoryOutputField::HistoryOutputField	(	string	fieldName_,
		ScreenOutputFormat	screenFormat_,
		string	OutputGroup_,
		HistoryFieldType	fieldType_,
		string	description_
	)

inline

Constructor to initialize all members.

Member Data Documentation

◆ description

string COutput::HistoryOutputField::description = ""

String containing the description of the field.

◆ fieldName

string COutput::HistoryOutputField::fieldName = ""

The name of the field, i.e. the name that is printed in the screen or file header.

◆ fieldType

HistoryFieldType COutput::HistoryOutputField::fieldType = HistoryFieldType::DEFAULT

The field type.

◆ outputGroup

string COutput::HistoryOutputField::outputGroup =""

The group this field belongs to.

◆ screenFormat

ScreenOutputFormat COutput::HistoryOutputField::screenFormat = ScreenOutputFormat::FIXED

The format that is used to print this value to screen.

◆ value

su2double COutput::HistoryOutputField::value = 0.0

The value of the field.

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

SU2_CFD/include/output/COutput.hpp

Public Member Functions

Public Attributes