Simulation configuration data. More...
#include <ProblemSetup.h>
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. | |
| 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.
◆ ~ProblemSetup()
| Aqua::InputOutput::ProblemSetup::~ProblemSetup | ( | ) |
Destructor.
Here is the call graph for this function:
Member Function Documentation
◆ 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/include/ProblemSetup.h
- /home/pepe/SPH/Code/aquagpusph/src/ProblemSetup.cpp
