A structure to hold user-defined control parameters for simulation settings. More...

#include <simulation_parameters.hpp>

Static Public Member Functions
static UserControlParameters	m_default ()
	Provides default settings for the UserControlParameters structure.

Public Attributes
double	biomass_initial_concentration
	Initial concentration of biomass.

double	final_time
	Final time for the simulation (in seconds).

double	delta_time
	Time step for the simulation (in seconds).

uint64_t	number_particle
	Number of particles in the simulation.

int32_t	n_thread
	Number of threads to use for simulation.

uint32_t	number_exported_result
	Number of results to be exported.

bool	recursive
	Flag to enable recursive processing.

bool	force_override
	Flag to allow overwriting of existing results.

bool	serde
	Flag to enable serialization/deserialization.

std::string	initialiser_path
	Path to the initialiser configuration file.

std::string	model_name
	Name of the simulation model.

std::string	results_file_name
	Name of the file where results are saved.

std::string	cma_case_path
	Path to the CMA case file.

std::optional< std::string >	serde_file
	Optional file path for serialized data.

Detailed Description

A structure to hold user-defined control parameters for simulation settings.

This struct is used to define parameters for configuring a simulation. Each parameter allows customization of the simulation's properties, runtime, and output settings.

Member Function Documentation

◆ m_default()

UserControlParameters Core::UserControlParameters::m_default ( )

static

Provides default settings for the UserControlParameters structure.

This static method returns an instance of UserControlParameters populated with default values for each field.

Member Data Documentation

◆ biomass_initial_concentration

double Core::UserControlParameters::biomass_initial_concentration

Initial concentration of biomass.

◆ cma_case_path

std::string Core::UserControlParameters::cma_case_path

Path to the CMA case file.

◆ delta_time

double Core::UserControlParameters::delta_time

Time step for the simulation (in seconds).

◆ final_time

double Core::UserControlParameters::final_time

Final time for the simulation (in seconds).

◆ force_override

bool Core::UserControlParameters::force_override

Flag to allow overwriting of existing results.

◆ initialiser_path

std::string Core::UserControlParameters::initialiser_path

Path to the initialiser configuration file.

◆ model_name

std::string Core::UserControlParameters::model_name

Name of the simulation model.

◆ n_thread

int32_t Core::UserControlParameters::n_thread

Number of threads to use for simulation.

◆ number_exported_result

uint32_t Core::UserControlParameters::number_exported_result

Number of results to be exported.

◆ number_particle

uint64_t Core::UserControlParameters::number_particle

Number of particles in the simulation.

◆ recursive

bool Core::UserControlParameters::recursive

Flag to enable recursive processing.

◆ results_file_name

std::string Core::UserControlParameters::results_file_name

Name of the file where results are saved.

◆ serde

bool Core::UserControlParameters::serde

Flag to enable serialization/deserialization.

◆ serde_file

std::optional<std::string> Core::UserControlParameters::serde_file

Optional file path for serialized data.

The documentation for this struct was generated from the following files:

apps/core/public/core/simulation_parameters.hpp
apps/core/src/simulation_parameters.cpp

Static Public Member Functions

Public Attributes