OutputsConfig Struct Reference

Kynema API: kynema::interfaces::components::OutputsConfig Struct Reference
Kynema API
A flexible multibody structural dynamics code for wind turbines
Loading...
Searching...
No Matches
kynema::interfaces::components::OutputsConfig Struct Reference

A configuration object used to create the Outputs object. More...

#include <outputs_config.hpp>

Public Member Functions

bool Enabled () const
 Check if outputs are enabled.
 

Public Attributes

std::string output_file_path
 Output file path for NetCDF results (empty = no outputs will be written)
 
std::vector< std::string > output_state_prefixes {"x", "u", "v", "a", "f"}
 Vector of state component prefixes to enable for writing.
 
size_t buffer_size {util::NodeStateWriter::kDefaultBufferSize}
 Number of timesteps to buffer before auto-flush.
 

Detailed Description

A configuration object used to create the Outputs object.

Member Function Documentation

◆ Enabled()

bool kynema::interfaces::components::OutputsConfig::Enabled ( ) const
inline

Check if outputs are enabled.

Member Data Documentation

◆ buffer_size

size_t kynema::interfaces::components::OutputsConfig::buffer_size {util::NodeStateWriter::kDefaultBufferSize}

Number of timesteps to buffer before auto-flush.

◆ output_file_path

std::string kynema::interfaces::components::OutputsConfig::output_file_path

Output file path for NetCDF results (empty = no outputs will be written)

◆ output_state_prefixes

std::vector<std::string> kynema::interfaces::components::OutputsConfig::output_state_prefixes {"x", "u", "v", "a", "f"}

Vector of state component prefixes to enable for writing.


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