Core Namespace Reference

Core component to perform simulation. More...

Namespaces
namespace	ScalarFactory
	Provides structures and functions to initialize scalar data for simulations, supporting multiple data sources.

Classes
struct	CaseData
	Holds the data required to execute a simulation case. More...
class	DataExporter
	A class responsible for exporting various types of data such as matrices, arrays, and metadata in a structured format. More...
class	GlobalInitialiser
	A class responsible for initializing various components of a simulation framework. More...
class	MainExporter
	Exporter for host-only data related to general-purpose simulation data (e.g., concentration, parameters, and other global data). More...
class	PartialExporter
	Exporter for each MPI worker (including host) that exports data relative to particle state. More...
class	SignalHandler
	Manages POSIX signals for the application. More...
struct	SimulationParameters
struct	UserControlParameters
	A structure to hold user-defined control parameters for simulation settings. More...

Typedefs
template<typename T>
using	OptionalPtr = GlobalInitialiser::OptionalPtr<T>

Functions
bool	check_results_file_name (Core::UserControlParameters &params)
void	exec (std::shared_ptr< IO::Logger > logger, CaseData &&case_data)
	Start simulation.
std::optional< Core::CaseData >	load (const ExecInfo &exec, const UserControlParameters &&params, std::optional< Simulation::Feed::SimulationFeed > feed=std::nullopt)
ExecInfo	runtime_init (int argc, char **argv, std::optional< std::size_t > force_run_id=std::nullopt)
	Initializes the runtime environment based on command-line arguments and simulation parameters.
std::ostream &	operator<< (std::ostream &stream, const UserControlParameters &params)
std::string	exporter_filename (const ExecInfo &exec, const SimulationParameters &params)
void	init_partial_exporter (Core::PartialExporter &partial_exporter, const CaseData &case_data)

Detailed Description

Core component to perform simulation.

Typedef Documentation

OptionalPtr

template<typename T>

using Core::OptionalPtr = GlobalInitialiser::OptionalPtr<T>

Function Documentation

check_results_file_name()

bool Core::check_results_file_name

(

Core::UserControlParameters &

params

)

Here is the caller graph for this function:

exec()

void Core::exec	(	std::shared_ptr< IO::Logger >	logger,
		CaseData &&	case_data )

Start simulation.

Here is the call graph for this function:

Here is the caller graph for this function:

exporter_filename()

std::string Core::exporter_filename	(	const ExecInfo &	exec,
		const SimulationParameters &	params )

Here is the call graph for this function:

Here is the caller graph for this function:

init_partial_exporter()

void Core::init_partial_exporter	(	Core::PartialExporter &	partial_exporter,
		const CaseData &	case_data )

Here is the call graph for this function:

Here is the caller graph for this function:

load()

std::optional< Core::CaseData > Core::load	(	const ExecInfo &	exec,
		const UserControlParameters &&	params,
		std::optional< Simulation::Feed::SimulationFeed >	feed = std::nullopt )

Here is the call graph for this function:

Here is the caller graph for this function:

operator<<()

std::ostream & Core::operator<<	(	std::ostream &	stream,
		const UserControlParameters &	params )

runtime_init()

ExecInfo Core::runtime_init	(	int	argc,
		char **	argv,
		std::optional< std::size_t >	force_run_id = std::nullopt )

Initializes the runtime environment based on command-line arguments and simulation parameters.

This function sets up the necessary runtime environment for the simulation by:

• Initializing MPI (Message Passing Interface) if applicable.
• Setting up Kokkos for parallel programming.
• Configuring functions to be executed upon program exit.
• Handling signals to ensure proper shutdown and resource cleanup.

The function uses the provided command-line arguments and simulation parameters to configure the runtime environment accordingly.

Parameters

argc	The number of command-line arguments.
argv	The array of command-line arguments. settings for the simulation.

Returns

An ExecInfo object containing details about the initialized runtime environment, including execution context and other relevant metadata.

Here is the call graph for this function:

Here is the caller graph for this function: