Aqua::InputOutput::ProblemSetup Class Reference

Simulation configuration data. More...

#include <ProblemSetup.hpp>

Collaboration diagram for Aqua::InputOutput::ProblemSetup:

Data Structures
struct	sphDefinitions
	OpenCL kernels compilation definitions. More...
class	sphParticlesSet
	Particles set data. More...
class	sphSettings
	General program settings. More...
struct	sphTimingParameters
	Simulation time flow options. More...
class	sphTool
	Tool to be executed. More...
struct	sphVariables
	Simulation variables registered. More...

Public Member Functions
	ProblemSetup ()
	Constructor.
	ProblemSetup (const ProblemSetup &p)
	Copy constructor.
	~ProblemSetup ()
	Destructor.
void	dims (unsigned int n)
	Set the number of dimensions.
unsigned int	dims () const
	Get the the number of dimensions.
void	nCmdQueues (unsigned int n)
	Set the maximum number of main OpenCL queues to be spawned.
unsigned int	nCmdQueues () const
	Get the maximum number of main OpenCL queues to be spawned.
unsigned int	toolInstances (ProblemSetup::sphTool *tool)
	Helper function to get the number of already defined instances of the same tool.

Data Fields
sphSettings	settings
	Stored settings.
sphVariables	variables
	Variables storage.
sphDefinitions	definitions
	Definitions storage.
std::vector< sphTool * >	tools
	Array of tools.
std::vector< sphTool * >	reports
	Array of reports.
struct Aqua::InputOutput::ProblemSetup::sphTimingParameters	time_opts
std::vector< sphParticlesSet * >	sets
	Array of particles sets.

Detailed Description

Simulation configuration data.

All the XML input configuration files should have the following form:

<?xml version="1.0" ?>
<sphInput>
    ...
</sphInput>

Where "..." is the configuration data.

See the user manual chapter 4.

See also

Aqua::InputOutput::State

Constructor & Destructor Documentation

ProblemSetup() [1/2]

Aqua::InputOutput::ProblemSetup::ProblemSetup

(

)

Constructor.

ProblemSetup() [2/2]

Aqua::InputOutput::ProblemSetup::ProblemSetup

(

const ProblemSetup &

p

)

Copy constructor.

Here is the call graph for this function:

~ProblemSetup()

Aqua::InputOutput::ProblemSetup::~ProblemSetup

(

)

Destructor.

Here is the call graph for this function:

Member Function Documentation

dims() [1/2]

unsigned int Aqua::InputOutput::ProblemSetup::dims ( ) const

inline

Get the the number of dimensions.

Returns

The number of dimensions, either 2 or 3

dims() [2/2]

void Aqua::InputOutput::ProblemSetup::dims ( unsigned int n )

inline

Set the number of dimensions.

Parameters

n	The number of dimensions, either 2 or 3

nCmdQueues() [1/2]

unsigned int Aqua::InputOutput::ProblemSetup::nCmdQueues ( ) const

inline

Get the maximum number of main OpenCL queues to be spawned.

Returns

The number of command queues

Note

The parallel MPI command queue used for communications is not took into account here

nCmdQueues() [2/2]

void Aqua::InputOutput::ProblemSetup::nCmdQueues ( unsigned int n )

inline

Set the maximum number of main OpenCL queues to be spawned.

Parameters

n	The number of command queues

Note

The parallel MPI command queue used for communications is not took into account here

toolInstances()

unsigned int Aqua::InputOutput::ProblemSetup::toolInstances

(

ProblemSetup::sphTool *

tool

)

Helper function to get the number of already defined instances of the same tool.

Since the same tool can be added several times (using wildcards), at the time of removing it the user should be careful before of checking that it is the last remaining instance.

Parameters

tool	Tool instance to look for

Returns

The number of instances found

Field Documentation

definitions

sphDefinitions Aqua::InputOutput::ProblemSetup::definitions

Definitions storage.

reports

std::vector<sphTool*> Aqua::InputOutput::ProblemSetup::reports

Array of reports.

Reports are a some kind of special tools dedicated to generate summary outputs.

sets

std::vector<sphParticlesSet*> Aqua::InputOutput::ProblemSetup::sets

Array of particles sets.

settings

sphSettings Aqua::InputOutput::ProblemSetup::settings

Stored settings.

time_opts

struct Aqua::InputOutput::ProblemSetup::sphTimingParameters Aqua::InputOutput::ProblemSetup::time_opts

tools

std::vector<sphTool*> Aqua::InputOutput::ProblemSetup::tools

Array of tools.

variables

sphVariables Aqua::InputOutput::ProblemSetup::variables

Variables storage.

---

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