MoCSI API Reference
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
SimulationClassDefault< T > Class Template Reference

#include <SimulationClassDefault.h>

Inheritance diagram for SimulationClassDefault< T >:
Inheritance graph
Collaboration diagram for SimulationClassDefault< T >:
Collaboration graph

Public Member Functions

 SimulationClassDefault ()
 
 SimulationClassDefault (int argc, const char *argv[])
 
 SimulationClassDefault (const std::string &user_ini)
 
int run () override
 
 ~SimulationClassDefault () override=default
 
- Public Member Functions inherited from SimulationClassBase< T >
 SimulationClassBase ()
 
 SimulationClassBase (const int argc, const char *argv[])
 Constructs a SimulationClassBase object and initializes its configuration.
 
 SimulationClassBase (const std::string &user_ini)
 
void setInitChainStr ()
 
void setPreTimeStepChainStr ()
 
void setPostTimeStepChainStr ()
 
void setPostNonLinIterChainStr ()
 
void setOutputChainStr ()
 
virtual void setUserIni (const std::string &user_ini)
 
void printField (const std::string &key)
 
const std::valarray< T > & getField (const std::string &key) const
 
const TgetFieldValue (const std::string &key, int pos) const
 
virtual ~SimulationClassBase ()=default
 

Public Attributes

std::string m_dependent_variable_name {"Temperature"}
 
std::string m_dependent_variable_initial_state {"initial_temperature"}
 
std::vector< std::shared_ptr< GenericManagingModule< T > > > m_all_modules {}
 
std::vector< std::shared_ptr< GenericSubmodule< T > > > m_all_submodules {}
 
- Public Attributes inherited from SimulationClassBase< T >
std::map< std::string, std::valarray< T > > m_field_map {}
 
std::string_view m_current_position
 
InputManager m_simulation_config {"ini_files/default.ini"}
 
T elapsed_time {0}
 
int time_step {0}
 
int my_rank {0}
 
int world_size {1}
 

Constructor & Destructor Documentation

◆ SimulationClassDefault() [1/3]

◆ SimulationClassDefault() [2/3]

template<typename T >
SimulationClassDefault< T >::SimulationClassDefault ( int  argc,
const char argv[] 
)

◆ SimulationClassDefault() [3/3]

template<typename T >
SimulationClassDefault< T >::SimulationClassDefault ( const std::string &  user_ini)

◆ ~SimulationClassDefault()

template<typename T >
SimulationClassDefault< T >::~SimulationClassDefault ( )
overridedefault

Member Function Documentation

◆ run()

template<typename T >
int SimulationClassDefault< T >::run ( )
overridevirtual

Member Data Documentation

◆ m_all_modules

template<typename T >
std::vector<std::shared_ptr<GenericManagingModule<T> > > SimulationClassDefault< T >::m_all_modules {}

◆ m_all_submodules

template<typename T >
std::vector<std::shared_ptr<GenericSubmodule<T> > > SimulationClassDefault< T >::m_all_submodules {}

◆ m_dependent_variable_initial_state

template<typename T >
std::string SimulationClassDefault< T >::m_dependent_variable_initial_state {"initial_temperature"}

◆ m_dependent_variable_name

template<typename T >
std::string SimulationClassDefault< T >::m_dependent_variable_name {"Temperature"}

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