Interface exposing the simulator to Java, Python, and C++ programs. More...

#include <SimWrapper.h>

Collaboration diagram for SimPT_Sim::SimWrapper:

Public Member Functions
SimWrapperResult< SimState >	GetState () const
	Provide sim state in format suitable for i/o.

SimWrapperResult< std::string >	GetXMLState () const
	Provide sim state in XML format serialized to string.

SimWrapperResult< void >	Initialize (SimState state)
	Set sim state.

SimWrapperResult< void >	Initialize (const std::string &path)
	Initialize (path to the input file) with full configuration (global info, parameters, random engine, mesh). More...

SimWrapperResult< void >	TimeStep ()
	Let simulator take a time step. More...

Detailed Description

Interface exposing the simulator to Java, Python, and C++ programs.

Definition at line 58 of file SimWrapper.h.

Member Function Documentation

SimWrapperResult< void > SimPT_Sim::SimWrapper::Initialize ( const std::string & path )

Initialize (path to the input file) with full configuration (global info, parameters, random engine, mesh).

This refers to the one-time complete setup prior to first use.

Definition at line 85 of file SimWrapper.cpp.

SimWrapperResult< void > SimPT_Sim::SimWrapper::TimeStep ( )

Let simulator take a time step.

Exceptions

Exception if something goes wrong.

Definition at line 101 of file SimWrapper.cpp.

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