openfluid::machine::Engine Class Reference

Detailed Description

Computation engine class

#include <machine/Engine.hpp>

Public Member Functions
	Engine ()=delete
	Engine (SimulationBlob &SimBlob, ModelInstance &MInstance, MonitoringInstance &OLInstance, openfluid::machine::MachineListener *MachineListener)
	~Engine ()
void	initialize ()
void	initParams ()
void	prepareData ()
void	checkConsistency ()
void	run ()
void	finalize ()
const openfluid::base::SimulationStatus *	simulationStatus ()
SimulationBlob *	simulationBlob ()
MachineListener *	machineListener ()
ModelInstance *	modelInstance ()
unsigned int	getWarningsCount () const

Static Public Member Functions
static std::size_t	computeValuesBuffersDefaultSize (const openfluid::core::Duration_t Duration, const openfluid::core::Duration_t DeltaT)

Constructor & Destructor Documentation

Engine() [1/2]

openfluid::machine::Engine::Engine ( )

delete

Engine() [2/2]

openfluid::machine::Engine::Engine	(	SimulationBlob &	SimBlob,
		ModelInstance &	MInstance,
		MonitoringInstance &	OLInstance,
		openfluid::machine::MachineListener *	MachineListener
	)

Constructor

~Engine()

openfluid::machine::Engine::~Engine ( )

inline

Destructor

Member Function Documentation

checkConsistency()

void openfluid::machine::Engine::checkConsistency

(

)

Executes the checkConsistency() method of each item of the model

computeValuesBuffersDefaultSize()

static std::size_t openfluid::machine::Engine::computeValuesBuffersDefaultSize ( const openfluid::core::Duration_t  Duration, const openfluid::core::Duration_t  DeltaT  )

inlinestatic

finalize()

void openfluid::machine::Engine::finalize

(

)

Finalizes the simulation engine

getWarningsCount()

unsigned int openfluid::machine::Engine::getWarningsCount ( ) const

inline

initialize()

void openfluid::machine::Engine::initialize

(

)

Initializes the simulation engine

initParams()

void openfluid::machine::Engine::initParams

(

)

Executes the initParams() method of each item of the model

machineListener()

MachineListener* openfluid::machine::Engine::machineListener ( )

inline

modelInstance()

ModelInstance* openfluid::machine::Engine::modelInstance ( )

inline

prepareData()

void openfluid::machine::Engine::prepareData

(

)

Executes the prepareData() method of each item of the model

run()

void openfluid::machine::Engine::run

(

)

Executes the initializeRun(), runStep() and finalizeRun() methods of each item of the model

simulationBlob()

SimulationBlob* openfluid::machine::Engine::simulationBlob ( )

inline

simulationStatus()

const openfluid::base::SimulationStatus* openfluid::machine::Engine::simulationStatus ( )

inline

---

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

• machine/Engine.hpp