Detailed Description
The output definition class selects quantities to be logged.
They are specified by a unique variable name and an object list with models containing the requested quantity. In the case of a vector-valued quantity the id or index must be given in brackets.
The extracted quantity will be treated like a scalar quantity.
Definition at line 43 of file NANDRAD_OutputDefinition.h.
#include <NANDRAD_OutputDefinition.h>
Public Types | |
| enum | timeType_t { OTT_NONE, OTT_MEAN, OTT_INTEGRAL, NUM_OTT } |
| Different options to handle time averaging/integration. More... | |
Public Attributes | |
| NANDRAD_READWRITE std::string | m_fileName |
| Filename (if empty then filename is generated automatically). More... | |
| std::string | m_quantity |
| Quantity id (for example, "AirTemperature"). More... | |
| timeType_t | m_timeType = NUM_OTT |
| Time output type (defaults to OTT_NONE). More... | |
| std::string | m_objectListName |
| Name of the object list. More... | |
| std::string | m_gridName |
| Rerefence name of output grid (corresponds to OutputGrid::m_name). More... | |
| const OutputGrid * | m_gridRef = nullptr |
| Pointer to output grid, assigned during project initialization within solver for fast access. More... | |
| const ObjectList * | m_objectListRef = nullptr |
| Pointer to object list, assigned during project initialization within solver for fast access. More... | |
Member Enumeration Documentation
◆ timeType_t
Different options to handle time averaging/integration.
| Enumerator | |
|---|---|
| OTT_NONE | Write outputs as calculated at output time points. |
| OTT_MEAN | Average value in last output interval. |
| OTT_INTEGRAL | Time integral of output value. |
Definition at line 47 of file NANDRAD_OutputDefinition.h.
Member Data Documentation
◆ m_fileName
| NANDRAD_READWRITE std::string NANDRAD::OutputDefinition::m_fileName |
Filename (if empty then filename is generated automatically).
Definition at line 65 of file NANDRAD_OutputDefinition.h.
◆ m_quantity
| std::string NANDRAD::OutputDefinition::m_quantity |
Quantity id (for example, "AirTemperature").
Definition at line 68 of file NANDRAD_OutputDefinition.h.
◆ m_timeType
| timeType_t NANDRAD::OutputDefinition::m_timeType = NUM_OTT |
Time output type (defaults to OTT_NONE).
Definition at line 71 of file NANDRAD_OutputDefinition.h.
◆ m_objectListName
| std::string NANDRAD::OutputDefinition::m_objectListName |
Name of the object list.
Definition at line 74 of file NANDRAD_OutputDefinition.h.
◆ m_gridName
| std::string NANDRAD::OutputDefinition::m_gridName |
Rerefence name of output grid (corresponds to OutputGrid::m_name).
Definition at line 77 of file NANDRAD_OutputDefinition.h.
◆ m_gridRef
| const OutputGrid* NANDRAD::OutputDefinition::m_gridRef = nullptr |
Pointer to output grid, assigned during project initialization within solver for fast access.
Definition at line 83 of file NANDRAD_OutputDefinition.h.
◆ m_objectListRef
| const ObjectList* NANDRAD::OutputDefinition::m_objectListRef = nullptr |
Pointer to object list, assigned during project initialization within solver for fast access.
Definition at line 86 of file NANDRAD_OutputDefinition.h.
The documentation for this class was generated from the following file:
