IRun.h File Reference

Basic interface defining a single run. More...

#include "common/ForwardDecl.h"
#include "objects/containers/List.h"
#include "objects/wrappers/Interval.h"
#include "objects/wrappers/SharedPtr.h"
#include "physics/Integrals.h"
#include "system/Settings.h"

Go to the source code of this file.

Classes
class	IRunCallbacks
	Callbacks executed by the simulation to provide feedback to the user. More...
class	IRun
	Defines the interface for a run. More...

Functions
Outcome	doRun (Storage &storage, const RunSettings &settings)
	Runs a simulation using provided storage as initial conditions. More...

Detailed Description

Basic interface defining a single run.

Author

Pavel Sevecek (sevecek at sirrah.troja.mff.cuni.cz)

Date

2016-2021

Definition in file IRun.h.

Function Documentation

doRun()

Outcome doRun	(	Storage &	storage,
		const RunSettings &	settings
	)

Runs a simulation using provided storage as initial conditions.

This function is a simple alternative to implementing the IRun interface. By providing the initial conditions and settings that specify the solver, timestepping, end time, etc., functions run the simulation and updates the Storage object with computed values of quantities.

Parameters

storage	Input/output storage containing initial conditions
settings	Parameters of the simulation

Returns

SUCCESS if computed successfully, otherwise an error message.

Definition at line 348 of file IRun.cpp.