GeneralSimulationParameters Class Reference

The GeneralSimulationParameters class stores paramaters for the 'GeneralSimulationParameters' XML element. More...

#include <Parameters.h>

Inheritance diagram for GeneralSimulationParameters:

Public Member Functions
	GeneralSimulationParameters ()
	Process paramaters for the 'GeneralSimulationParameters' XML element. More...
void	print_parameters ()
void	set_values (tinyxml2::XMLElement *xml_element)
	Set general parameters values from XML. More...
Public Member Functions inherited from ParameterLists
void	set_xml_element_name (const std::string &name)
void	set_parameter (const std::string &name, const bool value, bool required, Parameter< bool > &param)
	Set the name, default value and the parameter required flag. More...
void	set_parameter (const std::string &name, const double value, bool required, Parameter< double > &param)
void	set_parameter (const std::string &name, std::initializer_list< double > value, bool required, VectorParameter< double > &param)
void	set_parameter (const std::string &name, std::initializer_list< int > value, bool required, VectorParameter< int > &param)
void	set_parameter (const std::string &name, std::initializer_list< std::string > value, bool required, VectorParameter< std::string > &param)
void	set_parameter (const std::string &name, const int value, bool required, Parameter< int > &param, std::vector< int > range={})
void	set_parameter (const std::string &name, const std::string &value, bool required, Parameter< std::string > &param)
void	set_parameter_value (const std::string &name, const std::string &value)
	Set the value of a paramter from a string. More...
void	check_required ()
	Check if any required parameters have not been set. More...
std::map< std::string, std::string >	get_parameter_list ()
	Get the defined parameters as a map of strings. More...
void	print_parameter_list ()
	Print the parameters. More...

Public Attributes
std::string	xml_element_name
Parameter< bool >	check_ien_order
Parameter< bool >	continue_previous_simulation
Parameter< bool >	convert_bin_to_vtk_format
Parameter< bool >	debug
Parameter< bool >	overwrite_restart_file
Parameter< bool >	save_averaged_results
Parameter< bool >	save_results_to_vtk_format
Parameter< bool >	simulation_requires_remeshing
Parameter< bool >	start_averaging_from_zero
Parameter< bool >	verbose
Parameter< bool >	warning
Parameter< double >	spectral_radius_of_infinite_time_step
Parameter< double >	time_step_size
Parameter< int >	increment_in_saving_restart_files
Parameter< int >	increment_in_saving_vtk_files
Parameter< int >	number_of_spatial_dimensions
Parameter< int >	number_of_initialization_time_steps
Parameter< int >	start_saving_after_time_step
Parameter< int >	starting_time_step
Parameter< int >	number_of_time_steps
Parameter< std::string >	name_prefix_of_saved_vtk_files
Parameter< std::string >	restart_file_name
Parameter< std::string >	searched_file_name_to_trigger_stop
Parameter< std::string >	save_results_in_folder
Parameter< std::string >	simulation_initialization_file_path
Public Attributes inherited from ParameterLists
std::map< std::string, std::variant< Parameter< bool > *, Parameter< double > *, Parameter< int > *, Parameter< std::string > *, VectorParameter< double > *, VectorParameter< int > *, VectorParameter< std::string > * > >	params_map
	Map used for storing parameters by name / Parameter template union. More...
std::string	xml_element_name = ""

Detailed Description

The GeneralSimulationParameters class stores paramaters for the 'GeneralSimulationParameters' XML element.

<GeneralSimulationParameters>
  <Continue_previous_simulation> 0 </Continue_previous_simulation>
  <Number_of_spatial_dimensions> 3 </Number_of_spatial_dimensions>
  <Number_of_time_steps> 1 </Number_of_time_steps>
  <Time_step_size> 1e-4 </Time_step_size>
  <Spectral_radius_of_infinite_time_step> 0.50 </Spectral_radius_of_infinite_time_step>
  <Searched_file_name_to_trigger_stop> STOP_SIM </Searched_file_name_to_trigger_stop>
  <Save_results_to_VTK_format> true </Save_results_to_VTK_format>
  <Name_prefix_of_saved_VTK_files> result </Name_prefix_of_saved_VTK_files>
  <Increment_in_saving_VTK_files> 1 </Increment_in_saving_VTK_files>
  <Start_saving_after_time_step> 1 </Start_saving_after_time_step>
  <Increment_in_saving_restart_files> 1 </Increment_in_saving_restart_files>
  <Convert_BIN_to_VTK_format> 0 </Convert_BIN_to_VTK_format>
  <Verbose> 1 </Verbose>
  <Warning> 0 </Warning>
  <Debug> 0 </Debug>
  <Simulation_requires_remeshing> true </Simulation_requires_remeshing>
</GeneralSimulationParameters>

Constructor & Destructor Documentation

GeneralSimulationParameters()

GeneralSimulationParameters::GeneralSimulationParameters

(

)

Process paramaters for the 'GeneralSimulationParameters' XML element.

Member Function Documentation

set_values()

void GeneralSimulationParameters::set_values

(

tinyxml2::XMLElement *

xml_element

)

Set general parameters values from XML.

---

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

• svFSI/Parameters.h
• svFSI/Parameters.cpp