PyRun Class Reference

#include <PyRun.h>

Collaboration diagram for PyRun:

Public Member Functions
PyObject *	getGlobals () const
string	getInitString () const
string	getInputVar () const
PyObject *	getLocals () const
int	getMode () const
string	getOutputVar () const
string	getRunString () const
void	process (const Eref &e, ProcPtr p)
	PyRun ()
void	reinit (const Eref &e, ProcPtr p)
void	run (const Eref &e, string statement)
void	setGlobals (PyObject *globals)
void	setInitString (string str)
void	setInputVar (string name)
void	setLocals (PyObject *locals)
void	setMode (int flag)
void	setOutputVar (string name)
void	setRunString (string str)
void	trigger (const Eref &e, double input)
	~PyRun ()

Static Public Member Functions
static const Cinfo *	initCinfo ()

Static Public Attributes
static const int	RUNBOTH = 0
static const int	RUNPROC = 1
static const int	RUNTRIG = 2

Protected Attributes
PyObject *	globals_
PYCODEOBJECT *	initcompiled_
string	initstr_
string	inputvar_
PyObject *	locals_
int	mode_
string	outputvar_
PYCODEOBJECT *	runcompiled_
string	runstr_

Detailed Description

PyRun allows caling Python functions from moose.

Definition at line 77 of file PyRun.h.

Constructor & Destructor Documentation

PyRun::PyRun

(

)

Definition at line 182 of file PyRun.cpp.

References inputvar_, locals_, and value.

            :mode_(0), initstr_(""), runstr_(""),
               globals_(0), locals_(0),
               runcompiled_(0), initcompiled_(0),
               inputvar_("input_"), outputvar_("output")
{
    locals_ = PyDict_New();
    if (!locals_){
        cerr << "Could not initialize locals dict" << endl;
        return;
    }
    PyObject * value = PyFloat_FromDouble(0.0);
    if (!value && PyErr_Occurred()){
        PyErr_Print();
        return;
    }
    if (PyDict_SetItemString(locals_, inputvar_.c_str(), value)){
        PyErr_Print();
    }
}

PyRun::~PyRun

(

)

Definition at line 202 of file PyRun.cpp.

References globals_, and locals_.

{
    Py_XDECREF(globals_);
    Py_XDECREF(locals_);
}

Member Function Documentation

PyObject* PyRun::getGlobals

(

)

const

string PyRun::getInitString

(

)

const

Definition at line 223 of file PyRun.cpp.

References initstr_.

Referenced by initCinfo().

{
    return initstr_;
}

Here is the caller graph for this function:

string PyRun::getInputVar

(

)

const

Definition at line 234 of file PyRun.cpp.

References inputvar_.

Referenced by initCinfo().

{
    return inputvar_;
}

Here is the caller graph for this function:

PyObject* PyRun::getLocals

(

)

const

int PyRun::getMode

(

)

const

Definition at line 255 of file PyRun.cpp.

References mode_.

Referenced by initCinfo().

{
    return mode_;
}

Here is the caller graph for this function:

string PyRun::getOutputVar

(

)

const

Definition at line 245 of file PyRun.cpp.

References outputvar_.

Referenced by initCinfo().

{
    return outputvar_;
}

Here is the caller graph for this function:

string PyRun::getRunString

(

)

const

Definition at line 213 of file PyRun.cpp.

References runstr_.

Referenced by initCinfo().

{
    return runstr_;
}

Here is the caller graph for this function:

const Cinfo * PyRun::initCinfo ( )

static

Definition at line 67 of file PyRun.cpp.

References getInitString(), getInputVar(), getMode(), getOutputVar(), getRunString(), Neutral::initCinfo(), outputOut(), process(), pyRunCinfo, reinit(), run(), setInitString(), setInputVar(), setMode(), setOutputVar(), setRunString(), and trigger().

{
    static ValueFinfo< PyRun, string > runstring(
        "runString",
        "String to be executed at each time step.",
        &PyRun::setRunString,
        &PyRun::getRunString);

    static ValueFinfo< PyRun, string > initstring(
        "initString",
        "String to be executed at initialization (reinit).",
        &PyRun::setInitString,
        &PyRun::getInitString);

    static ValueFinfo< PyRun, string > inputvar(
        "inputVar",
        "Name of local variable in which input balue is to be stored. Default"
        " is `input_` (to avoid conflict with Python's builtin function"
        " `input`).",
        &PyRun::setInputVar,
        &PyRun::getInputVar);

    static ValueFinfo< PyRun, string > outputvar(
        "outputVar",
        "Name of local variable for storing output. Default is `output`.",
        &PyRun::setOutputVar,
        &PyRun::getOutputVar);

    static ValueFinfo< PyRun, int > mode(
        "mode",
        "Flag to indicate whether runString should be executed for both trigger and process, or one of them.",
        &PyRun::setMode,
        &PyRun::getMode);

    // static ValueFinfo< PyRun, PyObject* > globals(
    //     "globals",
    //     "Global environment dict",
    //     &PyRun::setGlobals,
    //     &PyRun::getGlobals);

    // static ValueFinfo< PyRun, PyObject* > locals(
    //     "locals",
    //     "Local environment dict",
    //     &PyRun::setLocals,
    //     &PyRun::getLocals);

    static DestFinfo trigger(
        "trigger",
        "Executes the current runString whenever a message arrives. It stores"
        " the incoming value in local variable named"
        " `input_`, which can be used in the"
        " `runString` (the underscore is added to avoid conflict with Python's"
        " builtin function `input`). If debug is True, it prints the input"
        " value.",
        new EpFunc1< PyRun, double >(&PyRun::trigger));

    static DestFinfo run(
        "run",
        "Runs a specified string. Does not modify existing run or init strings.",
        new EpFunc1< PyRun, string >(&PyRun::run));

    static DestFinfo process(
        "process",
        "Handles process call. Runs the current runString.",
        new ProcOpFunc< PyRun >(&PyRun::process));

    static DestFinfo reinit(
        "reinit",
        "Handles reinit call. Runs the current initString.",
        new ProcOpFunc< PyRun >( &PyRun::reinit ));

    static Finfo * processShared[] = { &process, &reinit };
    static SharedFinfo proc(
        "proc",
        "This is a shared message to receive Process messages "
        "from the scheduler objects."
        "The first entry in the shared msg is a MsgDest "
        "for the Process operation. It has a single argument, "
        "ProcInfo, which holds lots of information about current "
        "time, thread, dt and so on. The second entry is a MsgDest "
        "for the Reinit operation. It also uses ProcInfo. ",
        processShared, sizeof( processShared ) / sizeof( Finfo* ));

    static Finfo * pyRunFinfos[] = {
        &runstring,
        &initstring,
        &mode,
        &inputvar,
        &outputvar,
        &trigger,
        outputOut(),
        // &locals,
        // &globals,
        &run,
        &proc,
    };

    static string doc[] = {
        "Name", "PyRun",
        "Author", "Subhasis Ray",
        "Description", "Runs Python statements from inside MOOSE."};
    static Dinfo< PyRun > dinfo;
    static Cinfo pyRunCinfo(
        "PyRun",
        Neutral::initCinfo(),
        pyRunFinfos,
        sizeof(pyRunFinfos) / sizeof(Finfo*),
        &dinfo,
        doc,
        sizeof(doc) / sizeof(string));
    return &pyRunCinfo;
}

Here is the call graph for this function:

void PyRun::process	(	const Eref &	e,
		ProcPtr	p
	)

Definition at line 309 of file PyRun.cpp.

References globals_, locals_, mode_, output(), outputOut(), outputvar_, runcompiled_, and value.

Referenced by initCinfo().

{
    // PyRun_String(runstr_.c_str(), 0, globals_, locals_);
    // PyRun_SimpleString(runstr_.c_str());
    if (!runcompiled_ || mode_ == 2){
        return;
    }
    PyEval_EvalCode(runcompiled_, globals_, locals_);
    if (PyErr_Occurred()){
        PyErr_Print ();
    }
    PyObject * value = PyDict_GetItemString(locals_, outputvar_.c_str());
    if (value){
        double output = PyFloat_AsDouble(value);
        if (PyErr_Occurred()){
            PyErr_Print ();
        } else {
            outputOut()->send(e, output);
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void PyRun::reinit	(	const Eref &	e,
		ProcPtr	p
	)

Definition at line 357 of file PyRun.cpp.

References get_program_name(), globals_, handleError(), initcompiled_, initstr_, locals_, PYCODEOBJECT, runcompiled_, and runstr_.

Referenced by initCinfo().

{
    PyObject * main_module;
    if (globals_ == NULL){
        main_module = PyImport_AddModule("__main__");
        globals_ = PyModule_GetDict(main_module);
        Py_XINCREF(globals_);
    }
    if (locals_ == NULL){
        locals_ = PyDict_New();
        if (!locals_){
            cerr << "Could not initialize locals dict" << endl;
        }
    }
    initcompiled_ = (PYCODEOBJECT*)Py_CompileString(
        initstr_.c_str(),
        get_program_name().c_str(),
        Py_file_input);
    if (!initcompiled_){
        cerr << "Error compiling initString" << endl;
        handleError(true);
    } else {
        PyEval_EvalCode(initcompiled_, globals_, locals_);
        if (PyErr_Occurred()){
            PyErr_Print ();
        }
    }
    runcompiled_ = (PYCODEOBJECT*)Py_CompileString(
        runstr_.c_str(),
        get_program_name().c_str(),
        Py_file_input);
    if (!runcompiled_){
        cerr << "Error compiling runString" << endl;
        handleError(true);
    } else {
        PyEval_EvalCode(runcompiled_, globals_, locals_);
        if (PyErr_Occurred()){
            PyErr_Print ();
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void PyRun::run	(	const Eref &	e,
		string	statement
	)

Definition at line 295 of file PyRun.cpp.

References locals_, output(), outputOut(), outputvar_, and value.

Referenced by initCinfo().

{
    PyRun_SimpleString(statement.c_str());
    PyObject * value = PyDict_GetItemString(locals_, outputvar_.c_str());
    if (value){
        double output = PyFloat_AsDouble(value);
        if (PyErr_Occurred()){
            PyErr_Print ();
        } else {
            outputOut()->send(e, output);
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void PyRun::setGlobals

(

PyObject *

globals

)

void PyRun::setInitString

(

string

str

)

Definition at line 218 of file PyRun.cpp.

References initstr_.

Referenced by initCinfo().

{
    initstr_ = statement;
}

Here is the caller graph for this function:

void PyRun::setInputVar

(

string

name

)

Definition at line 228 of file PyRun.cpp.

References inputvar_, locals_, and name.

Referenced by initCinfo().

{
    PyDict_DelItemString(locals_, inputvar_.c_str());
    inputvar_ = name;
}

Here is the caller graph for this function:

void PyRun::setLocals

(

PyObject *

locals

)

void PyRun::setMode

(

int

flag

)

Definition at line 250 of file PyRun.cpp.

References mode_.

Referenced by initCinfo().

{
    mode_ = flag;
}

Here is the caller graph for this function:

void PyRun::setOutputVar

(

string

name

)

Definition at line 239 of file PyRun.cpp.

References locals_, name, and outputvar_.

Referenced by initCinfo().

{
    PyDict_DelItemString(locals_, outputvar_.c_str());
    outputvar_ = name;
}

Here is the caller graph for this function:

void PyRun::setRunString

(

string

str

)

Definition at line 208 of file PyRun.cpp.

References runstr_.

Referenced by initCinfo().

{
    runstr_ = statement;
}

Here is the caller graph for this function:

void PyRun::trigger	(	const Eref &	e,
		double	input
	)

Definition at line 260 of file PyRun.cpp.

References globals_, inputvar_, locals_, mode_, output(), outputOut(), outputvar_, runcompiled_, and value.

Referenced by initCinfo().

{
    if (!runcompiled_){
        return;
    }
    if (mode_ == 1){
        return;
    }

    PyObject * value = PyDict_GetItemString(locals_, inputvar_.c_str());
    if (value){
        Py_DECREF(value);
    }
    value = PyFloat_FromDouble(input);
    if (!value && PyErr_Occurred()){
        PyErr_Print();
    }
    if (PyDict_SetItemString(locals_, inputvar_.c_str(), value)){
        PyErr_Print();
    }
    PyEval_EvalCode(runcompiled_, globals_, locals_);
    if (PyErr_Occurred()){
        PyErr_Print ();
    }
    value = PyDict_GetItemString(locals_, outputvar_.c_str());
    if (value){
        double output = PyFloat_AsDouble(value);
        if (PyErr_Occurred()){
            PyErr_Print ();
        } else {
            outputOut()->send(e, output);
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

PyObject* PyRun::globals_

protected

Definition at line 121 of file PyRun.h.

Referenced by process(), reinit(), trigger(), and ~PyRun().

PYCODEOBJECT* PyRun::initcompiled_

protected

Definition at line 124 of file PyRun.h.

Referenced by reinit().

string PyRun::initstr_

protected

Definition at line 119 of file PyRun.h.

Referenced by getInitString(), reinit(), and setInitString().

string PyRun::inputvar_

protected

Definition at line 125 of file PyRun.h.

Referenced by getInputVar(), PyRun(), setInputVar(), and trigger().

PyObject* PyRun::locals_

protected

Definition at line 122 of file PyRun.h.

Referenced by process(), PyRun(), reinit(), run(), setInputVar(), setOutputVar(), trigger(), and ~PyRun().

int PyRun::mode_

protected

Definition at line 118 of file PyRun.h.

Referenced by getMode(), process(), setMode(), and trigger().

string PyRun::outputvar_

protected

Definition at line 126 of file PyRun.h.

Referenced by getOutputVar(), process(), run(), setOutputVar(), and trigger().

const int PyRun::RUNBOTH = 0

static

Definition at line 82 of file PyRun.h.

PYCODEOBJECT* PyRun::runcompiled_

protected

Definition at line 123 of file PyRun.h.

Referenced by process(), reinit(), and trigger().

const int PyRun::RUNPROC = 1

static

Definition at line 80 of file PyRun.h.

string PyRun::runstr_

protected

Definition at line 120 of file PyRun.h.

Referenced by getRunString(), reinit(), and setRunString().

const int PyRun::RUNTRIG = 2

static

Definition at line 81 of file PyRun.h.

---

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

• moose-core/pymoose/PyRun.h
• moose-core/pymoose/PyRun.cpp