AlbedoConstantCustom< T > Class Template Reference

Submodule that assigns a constant albedo value. More...

#include <AlbedoConstantCustom.h>

Inheritance diagram for AlbedoConstantCustom< T >:

Collaboration diagram for AlbedoConstantCustom< T >:

Public Member Functions
	AlbedoConstantCustom (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	calculateAlbedo ()
void	setFieldPtr (std::shared_ptr< std::valarray< T > > field_ptr) override
std::string_view	getNameLocal () const override
std::vector< std::string >	getDependencies () const override
Public Member Functions inherited from GenericSubmodule< T >
	GenericSubmodule ()
	Constructor without arguments. Will be employed when using the static modules registry.
virtual	~GenericSubmodule ()=default
	GenericSubmodule (const SimulationClassBase< T > *l_sim)
	Constructor to be preferably used when a module is created during runtime.
virtual bool	postNonLinIter ()
std::vector< std::string >	getSubmoduleList () const
bool	isSetUp ()
void	submodulesSetUp ()
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 the field pointer of the managing module 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< GenericSubmodule< T > >	createMethode (SimulationClassBase< T > *sim)
static std::string	getName ()

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

Detailed Description

template<typename T>
class AlbedoConstantCustom< T >

Submodule that assigns a constant albedo value.

AlbedoConstantCustom is a submodule that:

• Loads a user-supplied constant albedo from an .ini file.
• Updates the albedo field at initialization and pre-time-step stages.
• Integrates into the module chain used for surface albedo calculations.

Template Parameters

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

Constructor & Destructor Documentation

AlbedoConstantCustom()

template<typename T >

AlbedoConstantCustom< T >::AlbedoConstantCustom

(

SimulationClassBase< T > *

sim

)

Member Function Documentation

calculateAlbedo()

template<typename T >

void AlbedoConstantCustom< T >::calculateAlbedo

(

)

createMethode()

template<typename T >

static std::shared_ptr< GenericSubmodule< T > > AlbedoConstantCustom< T >::createMethode ( SimulationClassBase< T > *  sim )

inlinestatic

exec()

template<typename T >

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

overridevirtual

Implements GenericSubmodule< T >.

getDependencies()

template<typename T >

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

inlineoverridevirtual

Reimplemented from GenericSubmodule< T >.

getName()

template<typename T >

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

inlinestatic

getNameLocal()

template<typename T >

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

inlineoverridevirtual

Implements GenericSubmodule< T >.

init()

template<typename T >

bool AlbedoConstantCustom< T >::init ( )

overridevirtual

Reimplemented from GenericSubmodule< T >.

output()

template<typename T >

bool AlbedoConstantCustom< T >::output ( )

inlineoverridevirtual

Reimplemented from GenericSubmodule< T >.

postTimeStep()

template<typename T >

bool AlbedoConstantCustom< T >::postTimeStep ( )

inlineoverridevirtual

Reimplemented from GenericSubmodule< T >.

preTimeStep()

template<typename T >

bool AlbedoConstantCustom< T >::preTimeStep ( )

overridevirtual

Reimplemented from GenericSubmodule< T >.

setFieldPtr()

template<typename T >

void AlbedoConstantCustom< T >::setFieldPtr ( std::shared_ptr< std::valarray< T > >  field_ptr )

inlineoverridevirtual

Reimplemented from GenericSubmodule< T >.

setup()

template<typename T >

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

overridevirtual

Reimplemented from GenericSubmodule< T >.

---

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

• modules/albedo/AlbedoConstantCustom.h