Aqua::InputOutput::ProblemSetup::sphVariables Struct Reference

Simulation variables registered. More...

#include <ProblemSetup.h>

Public Member Functions
	sphVariables ()
	Constructor.
	~sphVariables ()
	Destructor.
void	registerVariable (std::string name, std::string type, std::string length, std::string value)
	Add a new variable.

Data Fields
std::vector< std::string >	names
	Name of the variables.
std::vector< std::string >	types
	Type of variables.
std::vector< std::string >	lengths
	Lengths.
std::vector< std::string >	values
	Values.

Detailed Description

Simulation variables registered.

In order to make AQUAgpusph more extensible, variables can be registered in runtime, specifing them in the input XML files.

The variables can be either scalars or arrays:

• int, unsigned int, float.
• ivec2, ivec3, ivec4.
• uivec2, uivec3, uivec4.
• vec2, vec3, vec4.
• ivec, uivec, vec.
• int*, unsigned int*, float*.
• ivec2*, ivec3*, ivec4*.
• uivec2*, uivec3*, uivec4*.
• vec2*, vec3*, vec4*.
• ivec*, uivec*, vec*.

These setting are set between the following XML tags:

<Variables>
</Variables>

See also

Aqua::InputOutput::Variables

Aqua::InputOutput::ProblemSetup

Constructor & Destructor Documentation

sphVariables()

Aqua::InputOutput::ProblemSetup::sphVariables::sphVariables ( )

inline

Constructor.

~sphVariables()

Aqua::InputOutput::ProblemSetup::sphVariables::~sphVariables ( )

inline

Destructor.

Member Function Documentation

registerVariable()

void Aqua::InputOutput::ProblemSetup::sphVariables::registerVariable	(	std::string	name,
		std::string	type,
		std::string	length,
		std::string	value
	)

Add a new variable.

It can be repeated, such that the variable will be overwritten later by the last instance found.

Parameters

name	Name of the variable.
type	Type of the varaible.
length	Array length, 1 for scalars, 0 for arrays that will not be allocated at the start (for instance the heads of chains, which requires the number of cells).
value	Variable value, NULL for arrays. It is optional for scalar variables.

Here is the call graph for this function:

Field Documentation

lengths

std::vector<std::string> Aqua::InputOutput::ProblemSetup::sphVariables::lengths

Lengths.

names

std::vector<std::string> Aqua::InputOutput::ProblemSetup::sphVariables::names

Name of the variables.

types

std::vector<std::string> Aqua::InputOutput::ProblemSetup::sphVariables::types

Type of variables.

values

std::vector<std::string> Aqua::InputOutput::ProblemSetup::sphVariables::values

Values.

---

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

• /home/pepe/SPH/Code/aquagpusph/include/ProblemSetup.h
• /home/pepe/SPH/Code/aquagpusph/src/ProblemSetup.cpp