SolarFlux< T > Class Template Reference

#include <SolarFlux.h>

Inheritance diagram for SolarFlux< T >:

Collaboration diagram for SolarFlux< T >:

Public Member Functions
	SolarFlux (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	postTimeStep () override
bool	output () override
void	writeToSim ()
std::vector< std::string >	getChainInsertion () const override
std::string_view	getNameLocal () const override
std::vector< std::string >	getDependencies () 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 bool	postNonLinIter ()
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

Constructor & Destructor Documentation

SolarFlux()

template<typename T >

SolarFlux< T >::SolarFlux

(

SimulationClassBase< T > *

sim

)

Member Function Documentation

createMethode()

template<typename T >

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

inlinestatic

exec()

template<typename T >

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

overridevirtual

Implements GenericManagingModule< T >.

getChainInsertion()

template<typename T >

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

inlineoverridevirtual

Reimplemented from GenericManagingModule< T >.

getDependencies()

template<typename T >

std::vector< std::string > SolarFlux< T >::getDependencies ( ) const

inlineoverridevirtual

Reimplemented from GenericManagingModule< T >.

getName()

template<typename T >

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

inlinestatic

getNameLocal()

template<typename T >

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

inlineoverridevirtual

Implements GenericManagingModule< T >.

init()

template<typename T >

bool SolarFlux< T >::init ( )

overridevirtual

Reimplemented from GenericManagingModule< T >.

output()

template<typename T >

bool SolarFlux< T >::output ( )

inlineoverridevirtual

Reimplemented from GenericManagingModule< T >.

postTimeStep()

template<typename T >

bool SolarFlux< T >::postTimeStep ( )

inlineoverridevirtual

Reimplemented from GenericManagingModule< T >.

preTimeStep()

template<typename T >

bool SolarFlux< T >::preTimeStep ( )

overridevirtual

Reimplemented from GenericManagingModule< T >.

setup()

template<typename T >

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

overridevirtual

Reimplemented from GenericManagingModule< T >.

writeToSim()

template<typename T >

void SolarFlux< T >::writeToSim

(

)

---

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

• modules/solar_flux/SolarFlux.h