OutputCsvTool< T > Class Template Reference

Saves specified simulation field data into CSV files. More...

#include <OutputCsvTool.h>

Inheritance diagram for OutputCsvTool< T >:

Collaboration diagram for OutputCsvTool< T >:

Public Member Functions
	OutputCsvTool (SimulationClassBase< T > *sim)
bool	setup (std::vector< std::shared_ptr< GenericSubmodule< T > > > all_submodules) override
bool	exec (std::string_view param) override
bool	init () override
bool	preTimeStep () override
bool	postNonLinIter () override
bool	postTimeStep () override
bool	output () override
std::vector< std::string >	getChainInsertion () const override
std::string_view	getNameLocal () const override
Public Member Functions inherited from GenericManagingModule< T >
	GenericManagingModule ()
	Constructor without arguments. Will be employed when using the static modules registry.
virtual	~GenericManagingModule ()=default
	GenericManagingModule (SimulationClassBase< T > *l_sim)
	Constructor to be preferably used when a module is created during runtime.
virtual std::vector< std::string >	getDependencies () const
virtual void	setSubmoduleList (std::vector< std::string > submodules)
std::vector< std::string >	getSubmoduleList () const
void	setSimPointer (SimulationClassBase< T > *sim)
	Setter function for the sim pointer. As the module is usually registered during static initialization when the sim class is not yet existing, this function is needed to set the pointer.
void	setSubmodules (std::vector< std::shared_ptr< GenericSubmodule< T > > > all_submodules)
	Sets all the submodules of this module into their corresponding chains. Also sets their field-pointers to this->module_field as a way to communicate between submodules.
void	writeToGlobalIniContent (std::ofstream &global_stream)
	Function that writes the local ini file contents to the global ini file stream. "Tags" the keys with the name of the module in the format "module_name$key".
void	overwriteLocalIniContent (const std::unordered_map< std::string, std::any > &global_ini_content)
	Writes the (already trimmed to the local content) data from the global ini file to the local ini file. This only overwrites the internal data and not the file contents itself.

Static Public Member Functions
static std::shared_ptr< GenericManagingModule< T > >	createMethode (SimulationClassBase< T > *sim)
static std::string	getName ()

Additional Inherited Members
Protected Attributes inherited from GenericManagingModule< T >
SimulationClassBase< T > *	sim {}
std::shared_ptr< std::valarray< T > >	module_field
ChainManager< GenericSubmodule< T > >	sub_module_chain
std::vector< std::string >	m_generic_submodules
InputManager	ini_file_data
bool	in_snapshot {false}
bool	in_output {false}
char	field_id

Detailed Description

template<typename T>
class OutputCsvTool< T >

Saves specified simulation field data into CSV files.

This managing module handles writing simulation fields to CSV files at specified time steps or intervals. It supports multiple save modes, including full-field and surface-layer outputs.

Key Features:

• Supports configurable save modes: "specific_time_steps", "interval", "surface", and combinations like "specific_time_steps_surface" or "interval_surface".
• Can save multiple fields specified in the module's INI file or updated dynamically by other modules.
• Writes elapsed simulation time alongside field data.
• Handles both volumetric fields and surface-layer data for layered simulations.
• Ensures precision in output using std::setprecision for numeric fields.

Template Parameters

T	Numeric type used in the simulation (e.g., float, double)

Constructor & Destructor Documentation

OutputCsvTool()

template<typename T >

OutputCsvTool< T >::OutputCsvTool

(

SimulationClassBase< T > *

sim

)

Member Function Documentation

createMethode()

template<typename T >

static std::shared_ptr< GenericManagingModule< T > > OutputCsvTool< T >::createMethode ( SimulationClassBase< T > *  sim )

inlinestatic

exec()

template<typename T >

bool OutputCsvTool< T >::exec ( std::string_view  param )

overridevirtual

Implements GenericManagingModule< T >.

getChainInsertion()

template<typename T >

std::vector< std::string > OutputCsvTool< T >::getChainInsertion ( ) const

inlineoverridevirtual

Reimplemented from GenericManagingModule< T >.

getName()

template<typename T >

static std::string OutputCsvTool< T >::getName ( )

inlinestatic

getNameLocal()

template<typename T >

std::string_view OutputCsvTool< T >::getNameLocal ( ) const

inlineoverridevirtual

Implements GenericManagingModule< T >.

init()

template<typename T >

bool OutputCsvTool< T >::init ( )

overridevirtual

Reimplemented from GenericManagingModule< T >.

output()

template<typename T >

bool OutputCsvTool< T >::output ( )

overridevirtual

Reimplemented from GenericManagingModule< T >.

postNonLinIter()

template<typename T >

bool OutputCsvTool< T >::postNonLinIter ( )

inlineoverridevirtual

Reimplemented from GenericManagingModule< T >.

postTimeStep()

template<typename T >

bool OutputCsvTool< T >::postTimeStep ( )

overridevirtual

Reimplemented from GenericManagingModule< T >.

preTimeStep()

template<typename T >

bool OutputCsvTool< T >::preTimeStep ( )

inlineoverridevirtual

Reimplemented from GenericManagingModule< T >.

setup()

template<typename T >

bool OutputCsvTool< T >::setup ( std::vector< std::shared_ptr< GenericSubmodule< T > > >  all_submodules )

overridevirtual

Reimplemented from GenericManagingModule< T >.

---

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

• modules/tools/OutputCsvTool.h