Documentation 6b54b78464
Loading...
Searching...
No Matches
COutput::VolumeOutputField Struct Reference

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

#include <COutput.hpp>

Public Member Functions

 VolumeOutputField ()=default
 Default constructor.
 
 VolumeOutputField (string fieldName_, string volumeOutputGroup_, 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 file header.
 
short offset = -1
 This value identifies the position of the values of this field at each node in the ::Local_Data array.
 
short offsetCompact = -1
 This offset is used for the compact formulation.
 
string outputGroup
 The group this field belongs to.
 
string description
 String containing the description of the field.
 

Detailed Description

Structure to store information for a volume output field.

The stored information is used to create the volume solution file.

Constructor & Destructor Documentation

◆ VolumeOutputField() [1/2]

COutput::VolumeOutputField::VolumeOutputField ( )
default

Default constructor.

◆ VolumeOutputField() [2/2]

COutput::VolumeOutputField::VolumeOutputField ( string  fieldName_,
string  volumeOutputGroup_,
string  description_ 
)
inline

Constructor to initialize all members.

Member Data Documentation

◆ description

string COutput::VolumeOutputField::description

String containing the description of the field.

◆ fieldName

string COutput::VolumeOutputField::fieldName

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

◆ offset

short COutput::VolumeOutputField::offset = -1

This value identifies the position of the values of this field at each node in the ::Local_Data array.

◆ offsetCompact

short COutput::VolumeOutputField::offsetCompact = -1

This offset is used for the compact formulation.

◆ outputGroup

string COutput::VolumeOutputField::outputGroup

The group this field belongs to.


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