OpenPSTD::Kernel::PSTDKernel Class Reference

The API with methods that run the simulation from a PSTDFile. More...

#include <PSTDKernel.h>

Inheritance diagram for OpenPSTD::Kernel::PSTDKernel:

Collaboration diagram for OpenPSTD::Kernel::PSTDKernel:

Public Member Functions
void	initialize_kernel (std::shared_ptr< PSTDConfiguration > config) override
	Sets the configuration, also initializes the kernel and the scene, constructs the domains and sets the parameters. More...
void	run (KernelCallback *callback) override
	Runs the kernel. More...
SimulationMetadata	get_metadata () override
	Query the kernel for metadata about the simulation that is configured.
std::shared_ptr< Kernel::Scene >	get_scene ()
	Return the scene of the simulation. More...

Detailed Description

The API with methods that run the simulation from a PSTDFile.

This API has two methods, one for initialization of the scene and the domains, and one for starting the actual simulation.

Member Function Documentation

std::shared_ptr< Kernel::Scene > OpenPSTD::Kernel::PSTDKernel::get_scene

(

)

Return the scene of the simulation.

Returns

: Shared pointer to simulation of the scene

void OpenPSTD::Kernel::PSTDKernel::initialize_kernel ( std::shared_ptr< PSTDConfiguration >  config )

overridevirtual

Sets the configuration, also initializes the kernel and the scene, constructs the domains and sets the parameters.

Parameters

config

Configuration file from the PSTDFile

Implements OpenPSTD::Kernel::KernelInterface.

void OpenPSTD::Kernel::PSTDKernel::run ( KernelCallback *  callback )

overridevirtual

Runs the kernel.

The callback has a single function that informs the rest of the application of the progress of the kernel.

Implements OpenPSTD::Kernel::KernelInterface.

---

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

• /home/omar/Software/cpp/openPSTD/kernel/PSTDKernel.h
• /home/omar/Software/cpp/openPSTD/kernel/PSTDKernel.cpp