General program settings. More...

#include <ProblemSetup.hpp>

Data Structures
class	device
	General program settings. More...

Public Types
enum	_debug { NO_DEBUG = 0 , DEBUG_EVENTS = 1<<0 , DEBUG_ARGS = 1<<1 , DEBUG_DEPS_SYNC = 1<<2 , DEBUG_SYNC = 1<<3 }
	Possible debugging modes. More...
typedef enum Aqua::InputOutput::ProblemSetup::sphSettings::_debug	debug_opts
	Possible debugging modes.

Public Member Functions
	sphSettings ()
	Constructor.
	~sphSettings ()
	Destructor.

Data Fields
bool	save_on_fail
	Save the output in case of failure.
int	debug_tools
	Debugging mode.
std::string	base_path
	AQUAgpusph root path.
std::vector< ProblemSetup::sphSettings::device >	devices
	The list of devices to be considered.

Detailed Description

General program settings.

These setting are set between the following XML tags:

</Settings>

See also: Aqua::InputOutput::ProblemSetup

Member Typedef Documentation

◆ debug_opts

typedef enum Aqua::InputOutput::ProblemSetup::sphSettings::_debug Aqua::InputOutput::ProblemSetup::sphSettings::debug_opts

Possible debugging modes.

Member Enumeration Documentation

◆ _debug

enum Aqua::InputOutput::ProblemSetup::sphSettings::_debug

Possible debugging modes.

Enumerator
NO_DEBUG	Do not debug.
DEBUG_EVENTS	Print information about the events and tools execution.
DEBUG_ARGS	Print information about kernel arguments setting.
DEBUG_DEPS_SYNC	Wait for a tool dependencies to finish after executing it.
DEBUG_SYNC	Wait for a tool to finish right after executing it.

Constructor & Destructor Documentation

◆ sphSettings()

Aqua::InputOutput::ProblemSetup::sphSettings::sphSettings ( )

Constructor.

Here is the call graph for this function:

◆ ~sphSettings()

Aqua::InputOutput::ProblemSetup::sphSettings::~sphSettings ( )

inline

Destructor.

Field Documentation

◆ base_path

std::string Aqua::InputOutput::ProblemSetup::sphSettings::base_path

AQUAgpusph root path.

Usually this option is automatically set by the basic module, using the tag RootPath. This path is added to the OpenCL include paths.

◆ debug_tools

int Aqua::InputOutput::ProblemSetup::sphSettings::debug_tools

Debugging mode.

Several options can be activated (see debug_opts). Some options are just printing additional information, while some others are forcing tools to be executed one by one, while they are logged. This obviously has a quite negative impact on the performance, but can be of use to find the tool which is causing issues.

You can enable the tools debugging with the following tag: <DebugTools events="true" args="true" sync="true" deps="true" />

Please, note that when sync attribute is true, deps attribute becomes useless

◆ devices

std::vector<ProblemSetup::sphSettings::device> Aqua::InputOutput::ProblemSetup::sphSettings::devices

The list of devices to be considered.

Devices can be added with the tag Device, for instance: <Device platform="0" device="0" type="GPU" />

In case MPI is enabled, devices are assigned to the processes in the same order they are declared in the XML file. Thus, the XML file and the MPI machine file must hold a strict relation

◆ save_on_fail

bool Aqua::InputOutput::ProblemSetup::sphSettings::save_on_fail

Save the output in case of failure.

If true, the particles sets and simulation state will be saved in case of failure/fatal error. Otherwise the simulation will just stop.

You can disable save on fail with the following tag (save on fail is enabled by default): <SaveOnFail value="false" />

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

/home/pepe/SPH/Code/aquagpusph/aquagpusph/ProblemSetup.hpp
/home/pepe/SPH/Code/aquagpusph/aquagpusph/ProblemSetup.cpp

Data Structures

Public Types

Public Member Functions

Data Fields