kynema::interfaces::components::OutputsBuilder Struct Reference

A builder class for building a outputs configuration. More...

#include <outputs_builder.hpp>

Public Member Functions
OutputsBuilder &	SetOutputFilePath (const std::string &output_file_path)
	Sets the output file path for NetCDF results.
OutputsBuilder &	SetOutputStatePrefixes (const std::vector< std::string > &prefixes)
	Sets the output state prefixes to be written to the output file.
OutputsBuilder &	SetOutputBufferSize (std::size_t buffer_size)
	Sets the number of output timesteps to buffer before flushing to disk.
OutputsConfig	Config () const
	Creates an OutputsConfig object based on the previously set parameters.

Detailed Description

A builder class for building a outputs configuration.

Member Function Documentation

Config()

OutputsConfig kynema::interfaces::components::OutputsBuilder::Config ( ) const

inline

Creates an OutputsConfig object based on the previously set parameters.

Returns

The completed OutputsConfig object

SetOutputBufferSize()

OutputsBuilder & kynema::interfaces::components::OutputsBuilder::SetOutputBufferSize ( std::size_t  buffer_size )

inline

Sets the number of output timesteps to buffer before flushing to disk.

Parameters

buffer_size

Number of timesteps to buffer

Returns

A reference to this outputs builder object to allow chaining

SetOutputFilePath()

OutputsBuilder & kynema::interfaces::components::OutputsBuilder::SetOutputFilePath ( const std::string &  output_file_path )

inline

Sets the output file path for NetCDF results.

If the file path is empty, no output will be written to disk. This must be set to enable automatic output operations at each timestep.

Parameters

output_file_path

Path where the output NetCDF file will be written

Returns

Reference to this OutputsBuilder object, enabling method chaining

SetOutputStatePrefixes()

OutputsBuilder & kynema::interfaces::components::OutputsBuilder::SetOutputStatePrefixes ( const std::vector< std::string > &  prefixes )

inline

Sets the output state prefixes to be written to the output file.

Parameters

prefixes

Vector of variable name prefixes

Returns

A reference to this outputs builder object to allow chaining

---

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

• /home/runner/work/kynema/kynema/kynema/src/interfaces/components/outputs_builder.hpp