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 <LibUtilities/Python/BasicUtils/SharedArray.hpp>

Go to the source code of this file.

Functions
void	Interpreter_AddConstants (std::shared_ptr< Interpreter > interpreter, py::args args, const py::kwargs &kwargs)
	Wrapper for Interpreter::AddConstants. More...
void	Interpreter_SetParameters (std::shared_ptr< Interpreter > interpreter, py::args args, const py::kwargs &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 (py::module &m)

Function Documentation

export_Interpreter()

void export_Interpreter

(

py::module &

m

)

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

{
    py::class_<Interpreter, std::shared_ptr<Interpreter>>(m, "Interpreter")
 
        .def(py::init<>())
 
        .def("SetRandomSeed", &Interpreter::SetRandomSeed)
 
        .def("AddConstants", &Interpreter_AddConstants)
        .def("AddConstant", &Interpreter::AddConstant)
        .def("GetConstant", Interpreter_GetConstant)
 
        .def("SetParameters", &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 Interpreter_AddConstants(), Interpreter_Evaluate(), Interpreter_Evaluate2(), Interpreter_Evaluate3(), Interpreter_Evaluate4(), Interpreter_GetConstant(), Interpreter_GetParameter(), and Interpreter_SetParameters().

Referenced by PYBIND11_MODULE().

Interpreter_AddConstants()

void Interpreter_AddConstants	(	std::shared_ptr< Interpreter >	interpreter,
		py::args	args,
		const py::kwargs &	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.

{
    // Map that will be passed to C++
    std::map<std::string, NekDouble> constants;
 
    // Loop over the keys inside the kwargs dictionary
    for (auto &it : kwargs)
    {
        const std::string &key = py::cast<const std::string>(it.first);
        const NekDouble &val   = py::cast<const NekDouble>(it.second);
        constants[key]         = val;
    }
 
    interpreter->AddConstants(constants);
}

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 142 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 160 of file Python/Interpreter/Interpreter.cpp.

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

References Nektar::UnitTests::z().

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 182 of file Python/Interpreter/Interpreter.cpp.

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

References Nektar::UnitTests::z().

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 203 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 127 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 112 of file Python/Interpreter/Interpreter.cpp.

{
 
    return interpreter->GetParameter(paramName);
}

Referenced by export_Interpreter().

Interpreter_SetParameters()

void Interpreter_SetParameters	(	std::shared_ptr< Interpreter >	interpreter,
		py::args	args,
		const py::kwargs &	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 87 of file Python/Interpreter/Interpreter.cpp.

{
    // Map that will be passed to C++
    std::map<std::string, NekDouble> parameters;
 
    // Loop over the keys inside the kwargs dictionary
    for (auto &it : kwargs)
    {
        const std::string &key = py::cast<const std::string>(it.first);
        const NekDouble &val   = py::cast<const NekDouble>(it.second);
        parameters[key]        = val;
    }
 
    interpreter->SetParameters(parameters);
}

Referenced by export_Interpreter().