Aqua::InputOutput::ProblemSetup::sphTimingParameters Struct Reference

Simulation time flow options. More...

#include <ProblemSetup.h>

Data Fields
unsigned int	sim_end_mode
	Simulation finish criteria to apply.
float	sim_end_time
	Simulation finish time instant.
int	sim_end_step
	Total number of time steps to compute.
int	sim_end_frame
	Total number of output frames to write.
unsigned int	output_mode
	Particles output updating criteria to apply.
float	output_fps
	Particles output updating rate.
int	output_ipf
	Particles output updating rate.
unsigned int	dt_mode
	Time step \( \Delta t \) computation method.

Detailed Description

Simulation time flow options.

This options are used to control the simulation time step, the output files frequency or the simulation finish criteria.

These setting are set between the following XML tags:

<Timing>
</Timing>

See also

Aqua::InputOutput::ProblemSetup

Aqua::InputOutput::TimeManager

Field Documentation

dt_mode

unsigned int Aqua::InputOutput::ProblemSetup::sphTimingParameters::dt_mode

Time step \( \Delta t \) computation method.

The time step \( \Delta t \) can be computed in 3 ways (they cannot be combined):

• #__DT_VARIABLE__ : Time step \( \Delta t \) is recomputed each iteration.
• #__DT_FIXCALCULATED__ : Time step \( \Delta t \) is computed at the start of the simulation, being constant after that.
• #__DT_FIX__ : Time step \( \Delta t \) is manually specified by the user.

This field can be set with the tag Option, for instance:

• <Option name="TimeStep" value="Variable" />
• <Option name="TimeStep" value="Fixed" />
• <Option name="TimeStep" value="0.1" />

See also

Aqua::InputOutput::TimeManager

Aqua::CalcServer::TimeStep

output_fps

float Aqua::InputOutput::ProblemSetup::sphTimingParameters::output_fps

Particles output updating rate.

If __FPS_MODE__ is set in output_mode, the particles output will be updated this value times per second of simulations.

This field can be set with the tag Option, for instance: <Option name="Output" type="FPS" value="120" />

See also

output_mode

output_ipf

int Aqua::InputOutput::ProblemSetup::sphTimingParameters::output_ipf

Particles output updating rate.

If __IPF_MODE__ is set in output_mode, the particles output will be updated every time that this value of time steps is computed.

This field can be set with the tag Option, for instance: <Option name="Output" type="IPF" value="10" />

See also

output_mode

output_mode

unsigned int Aqua::InputOutput::ProblemSetup::sphTimingParameters::output_mode

Particles output updating criteria to apply.

The particles output may be hard disk heavily demanding, hardly affecting the general program performance as well, therefore it is strongly recommended to try to write it as less often as possible

Must a combination of the following options:

• __NO_OUTPUT_MODE__ : The log file will not be never updated (default value).
• __FPS_MODE__ : Frames per second.
• __IPF_MODE__ : Iterations (time steps) per frame.

This field can be set with the tag Option, for instance:

• <Option name="Output" type="FPS" value="120" />
• <Option name="Output" type="IPF" value="10" />

See also

Aqua::InputOutput::Particles

sim_end_frame

int Aqua::InputOutput::ProblemSetup::sphTimingParameters::sim_end_frame

Total number of output frames to write.

If __FRAME_MODE__ is set in sim_end_mode, the simulation will be stopped when this output frames are written.

This field can be set with the tag Option, for instance: <Option name="End" type="Frames" value="10" />

See also

sim_end_mode

sim_end_mode

unsigned int Aqua::InputOutput::ProblemSetup::sphTimingParameters::sim_end_mode

Simulation finish criteria to apply.

Must a combination of the following options:

• __TIME_MODE__ : Maximum simulated time.
• __ITER_MODE__ : Maximum number os time steps.
• __FRAME_MODE__ : Maximum number of output frames printed.

This field can be set with the tag Option, for instance:

• <Option name="End" type="Time" value="1.0" />
• <Option name="End" type="Steps" value="10000" />
• <Option name="End" type="Frames" value="10" />

Warning

If no simulation stop criteria is selected, the simulation will not stop until an error is reached, or it is manually stopped.

sim_end_step

int Aqua::InputOutput::ProblemSetup::sphTimingParameters::sim_end_step

Total number of time steps to compute.

If __ITER_MODE__ is set in sim_end_mode, the simulation will be stopped when this simulation time steps are computed.

This field can be set with the tag Option, for instance: <Option name="End" type="Steps" value="10000" />

See also

sim_end_mode

sim_end_time

float Aqua::InputOutput::ProblemSetup::sphTimingParameters::sim_end_time

Simulation finish time instant.

If __TIME_MODE__ is set in sim_end_mode, the simulation will be stopped when this simulation time instant is reached.

This field can be set with the tag Option, for instance: <Option name="End" type="Time" value="1.0" />

See also

sim_end_mode

---

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

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