Python/Interpreter/Interpreter.cpp File Reference

#include <LibUtilities/Interpreter/Interpreter.h>
#include <LibUtilities/BasicConst/NektarUnivTypeDefs.hpp>
#include <LibUtilities/Python/NekPyConfig.hpp>
#include <LibUtilities/BasicUtils/ErrorUtil.hpp>
#include <boost/python/raw_function.hpp>

Go to the source code of this file.

Functions
py::object	Interpreter_AddConstants (py::tuple args, py::dict kwargs)
	Wrapper for Interpreter::AddConstants. More...
py::object	Interpreter_SetParameters (py::tuple args, py::dict kwargs)
	Wrapper for Interpreter::SetParameters. More...
NekDouble	Interpreter_GetParameter (std::shared_ptr< Interpreter > interpreter, std::string paramName)
	Wrapper for Interpreter::GetParameter. More...
NekDouble	Interpreter_GetConstant (std::shared_ptr< Interpreter > interpreter, std::string constantName)
	Wrapper for Interpreter::GetConstant. More...
NekDouble	Interpreter_Evaluate (std::shared_ptr< Interpreter > interpreter, const int id)
	Wrapper for Interpreter::Evaluate (only constant or parameter). More...
NekDouble	Interpreter_Evaluate2 (std::shared_ptr< Interpreter > interpreter, const int id, const NekDouble x, const NekDouble y, const NekDouble z, const NekDouble t)
	Wrapper for Interpreter::Evaluate (only constant parameters). More...
Array< OneD, NekDouble >	Interpreter_Evaluate3 (std::shared_ptr< Interpreter > interpreter, const int id, const Array< OneD, const NekDouble > &x, const Array< OneD, const NekDouble > &y, const Array< OneD, const NekDouble > &z, const Array< OneD, const NekDouble > &t)
	Wrapper for Interpreter::Evaluate (vectorised version of the evaluation method that will allow the same function to be evaluated many times). More...
Array< OneD, NekDouble >	Interpreter_Evaluate4 (std::shared_ptr< Interpreter > interpreter, const int expression_id, const std::vector< Array< OneD, const NekDouble >> &points)
	Wrapper for Interpreter::Evaluate (zero or more arrays). More...
void	export_Interpreter ()

Function Documentation

export_Interpreter()

void export_Interpreter

(

)

Definition at line 226 of file Python/Interpreter/Interpreter.cpp.

{
    py::class_<Interpreter, std::shared_ptr<Interpreter>, boost::noncopyable>(
        "Interpreter", py::init<>())
 
        .def("SetRandomSeed", &Interpreter::SetRandomSeed)
 
        .def("AddConstants", py::raw_function(Interpreter_AddConstants))
        .def("AddConstant", &Interpreter::AddConstant)
        .def("GetConstant", Interpreter_GetConstant)
 
        .def("SetParameters", py::raw_function(Interpreter_SetParameters))
        .def("SetParameter", &Interpreter::SetParameter)
        .def("GetParameter", Interpreter_GetParameter)
 
        .def("GetTime", &Interpreter::GetTime)
        .def("DefineFunction", &Interpreter::DefineFunction)
 
        .def("Evaluate", Interpreter_Evaluate)
        .def("Evaluate", Interpreter_Evaluate2)
        .def("Evaluate", Interpreter_Evaluate3)
        .def("Evaluate", Interpreter_Evaluate4)
 
        ;
}

References Nektar::LibUtilities::Interpreter::AddConstant(), Nektar::LibUtilities::Interpreter::DefineFunction(), Nektar::LibUtilities::Interpreter::GetTime(), Interpreter_AddConstants(), Interpreter_Evaluate(), Interpreter_Evaluate2(), Interpreter_Evaluate3(), Interpreter_Evaluate4(), Interpreter_GetConstant(), Interpreter_GetParameter(), Interpreter_SetParameters(), Nektar::LibUtilities::Interpreter::SetParameter(), and Nektar::LibUtilities::Interpreter::SetRandomSeed().

Referenced by BOOST_PYTHON_MODULE().

Interpreter_AddConstants()

py::object Interpreter_AddConstants	(	py::tuple	args,
		py::dict	kwargs
	)

Wrapper for Interpreter::AddConstants.

boost.python does not know how (by default) to convert from any Python datatype to a C++ map, so we add a pythonic way to set parameters through keyword arguments.

Parameters

args	Python function positional arguments.
kwargs	Python function keyword arguments.

Returns

None (null py::object).

Definition at line 58 of file Python/Interpreter/Interpreter.cpp.

{
    // To extract the 'self' object
    Interpreter &interpreter = py::extract<Interpreter &>(args[0]);
 
    // Map that will be passed to C++
    std::map<std::string, NekDouble> constants;
 
    // Loop over the keys inside the kwargs dictionary
    py::list keys = kwargs.keys();
    for (int i = 0; i < py::len(keys); ++i)
    {
        py::object arg = kwargs[keys[i]];
        if (arg)
        {
            constants[py::extract<std::string>(keys[i])] =
                py::extract<NekDouble>(arg);
        }
    }
 
    interpreter.AddConstants(constants);
    return py::object();
}

References Nektar::LibUtilities::Interpreter::AddConstants().

Referenced by export_Interpreter().

Interpreter_Evaluate()

NekDouble Interpreter_Evaluate	(	std::shared_ptr< Interpreter >	interpreter,
		const int	id
	)

Wrapper for Interpreter::Evaluate (only constant or parameter).

Parameters

interpreter	Interpreter object
id	id of the expression

Returns

Value corresponding to id

Definition at line 156 of file Python/Interpreter/Interpreter.cpp.

{
    return interpreter->Evaluate(id);
}

Referenced by export_Interpreter().

Interpreter_Evaluate2()

NekDouble Interpreter_Evaluate2	(	std::shared_ptr< Interpreter >	interpreter,
		const int	id,
		const NekDouble	x,
		const NekDouble	y,
		const NekDouble	z,
		const NekDouble	t
	)

Wrapper for Interpreter::Evaluate (only constant parameters).

Parameters

interpreter	Interpreter object
id	id of the expression
x	x-coordinate within the expression
y	y-coordinate within the expression
z	z-coordinate within the expression
t	value of time within the expression

Returns

Value of evaluated expression.

Definition at line 174 of file Python/Interpreter/Interpreter.cpp.

{
    return interpreter->Evaluate(id, x, y, z, t);
}

Referenced by export_Interpreter().

Interpreter_Evaluate3()

Array<OneD, NekDouble> Interpreter_Evaluate3	(	std::shared_ptr< Interpreter >	interpreter,
		const int	id,
		const Array< OneD, const NekDouble > &	x,
		const Array< OneD, const NekDouble > &	y,
		const Array< OneD, const NekDouble > &	z,
		const Array< OneD, const NekDouble > &	t
	)

Wrapper for Interpreter::Evaluate (vectorised version of the evaluation method that will allow the same function to be evaluated many times).

Parameters

interpreter	Interpreter object
id	id of the expression
x	x-coordinates within the expression
y	y-coordinates within the expression
z	z-coordinates within the expression
t	values of time within the expression

Returns

Values of evaluated expression.

Definition at line 196 of file Python/Interpreter/Interpreter.cpp.

{
    Array<OneD, NekDouble> tmp(x.size());
    interpreter->Evaluate(id, x, y, z, t, tmp);
    return tmp;
}

Referenced by export_Interpreter().

Interpreter_Evaluate4()

Array<OneD, NekDouble> Interpreter_Evaluate4	(	std::shared_ptr< Interpreter >	interpreter,
		const int	expression_id,
		const std::vector< Array< OneD, const NekDouble >> &	points
	)

Wrapper for Interpreter::Evaluate (zero or more arrays).

Parameters

expression_id	id of the expression
points	vector containing arrays of values required for the expression.

Returns

Values of evaluated expression.

Definition at line 217 of file Python/Interpreter/Interpreter.cpp.

{
    Array<OneD, NekDouble> tmp(points.size());
    interpreter->Evaluate(expression_id, points, tmp);
    return tmp;
}

Referenced by export_Interpreter().

Interpreter_GetConstant()

NekDouble Interpreter_GetConstant	(	std::shared_ptr< Interpreter >	interpreter,
		std::string	constantName
	)

Wrapper for Interpreter::GetConstant.

Parameters

interpreter	Interpreter object
constantName	Name of constant

Returns

Constant defined by constantName.

Definition at line 141 of file Python/Interpreter/Interpreter.cpp.

{
 
    return interpreter->GetConstant(constantName);
}

Referenced by export_Interpreter().

Interpreter_GetParameter()

NekDouble Interpreter_GetParameter	(	std::shared_ptr< Interpreter >	interpreter,
		std::string	paramName
	)

Wrapper for Interpreter::GetParameter.

Parameters

interpreter	Interpreter object
paramName	Name of parameter

Returns

Parameter defined by paramName.

Definition at line 126 of file Python/Interpreter/Interpreter.cpp.

{
 
    return interpreter->GetParameter(paramName);
}

Referenced by export_Interpreter().

Interpreter_SetParameters()

py::object Interpreter_SetParameters	(	py::tuple	args,
		py::dict	kwargs
	)

Wrapper for Interpreter::SetParameters.

boost.python does not know how (by default) to convert from any Python datatype to a C++ map, so we add a pythonic way to set parameters through keyword arguments.

Parameters

args	Python function positional arguments.
kwargs	Python function keyword arguments.

Returns

None (null py::object).

Definition at line 94 of file Python/Interpreter/Interpreter.cpp.

{
 
    // To extract the 'self' object
    Interpreter &interpreter = py::extract<Interpreter &>(args[0]);
 
    // Map that will be passed to C++
    std::map<std::string, NekDouble> parameters;
 
    // Loop over the keys inside the kwargs dictionary
    py::list keys = kwargs.keys();
    for (int i = 0; i < py::len(keys); ++i)
    {
        py::object arg = kwargs[keys[i]];
        if (arg)
        {
            parameters[py::extract<std::string>(keys[i])] =
                py::extract<NekDouble>(arg);
        }
    }
    interpreter.SetParameters(parameters);
    return py::object();
}

References Nektar::LibUtilities::Interpreter::SetParameters().

Referenced by export_Interpreter().