Python/BasicUtils/Equation.cpp File Reference

#include <LibUtilities/BasicUtils/Equation.h>
#include <LibUtilities/Interpreter/Interpreter.h>
#include <LibUtilities/Python/NekPyConfig.hpp>
#include <LibUtilities/Python/BasicUtils/SharedArray.hpp>
#include <LibUtilities/BasicConst/NektarUnivTypeDefs.hpp>

Go to the source code of this file.

Functions
void	Equation_SetConstants (std::shared_ptr< Equation > equation, py::args args, const py::kwargs &kwargs)
	Wrapper for Equation::SetConstants. More...
std::shared_ptr< Equation >	ConstructEquation (std::shared_ptr< Interpreter > interp, std::string expr, std::string vlist)
	Construct an equation object from an expression string expr and a list of variables vlist. More...
NekDouble	Equation_Evaluate1 (std::shared_ptr< Equation > equation)
	Wrapper for Equation::Evaluate (overloaded for no parameters). More...
NekDouble	Equation_Evaluate2 (std::shared_ptr< Equation > equation, const NekDouble x, const NekDouble y=0, const NekDouble z=0, const NekDouble t=0)
	Wrapper for Equation::Evaluate (overloaded for constant parameters). More...
Array< OneD, NekDouble >	Equation_Evaluate3 (std::shared_ptr< Equation > equation, const Array< OneD, const NekDouble > &x, const Array< OneD, const NekDouble > &y, const Array< OneD, const NekDouble > &z)
	Wrapper for Equation::Evaluate (overloaded for Array parameters). More...
Array< OneD, NekDouble >	Equation_Evaluate4 (std::shared_ptr< Equation > equation, const Array< OneD, const NekDouble > &x, const Array< OneD, const NekDouble > &y, const Array< OneD, const NekDouble > &z, const NekDouble t)
	Wrapper for Equation::Evaluate (overloaded for Array parameters + constant time). More...
Array< OneD, NekDouble >	Equation_Evaluate5 (std::shared_ptr< Equation > equation, 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 Equation::Evaluate (overloaded for Array parameters + Array time). More...
void	export_Equation (py::module &m)

Function Documentation

ConstructEquation()

std::shared_ptr< Equation > ConstructEquation	(	std::shared_ptr< Interpreter >	interp,
		std::string	expr,
		std::string	vlist
	)

Construct an equation object from an expression string expr and a list of variables vlist.

Parameters

evaluator	Interpreter object
expr	String contaning the expression
vlist	String contining the list of variables in expr.

Returns

An #Equation object.

Definition at line 84 of file Python/BasicUtils/Equation.cpp.

{
    return std::make_shared<Equation>(interp, expr, vlist);
}

Referenced by export_Equation().

Equation_Evaluate1()

NekDouble Equation_Evaluate1

(

std::shared_ptr< Equation >

equation

)

Wrapper for Equation::Evaluate (overloaded for no parameters).

Parameters

equation

Equation object

Returns

Value of equation.

Definition at line 97 of file Python/BasicUtils/Equation.cpp.

{
    return equation->Evaluate();
}

Referenced by export_Equation().

Equation_Evaluate2()

NekDouble Equation_Evaluate2	(	std::shared_ptr< Equation >	equation,
		const NekDouble	x,
		const NekDouble	y = 0,
		const NekDouble	z = 0,
		const NekDouble	t = 0
	)

Wrapper for Equation::Evaluate (overloaded for constant parameters).

Parameters

equation	Equation object from Python
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 113 of file Python/BasicUtils/Equation.cpp.

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

References Nektar::UnitTests::z().

Referenced by export_Equation().

Equation_Evaluate3()

Array< OneD, NekDouble > Equation_Evaluate3	(	std::shared_ptr< Equation >	equation,
		const Array< OneD, const NekDouble > &	x,
		const Array< OneD, const NekDouble > &	y,
		const Array< OneD, const NekDouble > &	z
	)

Wrapper for Equation::Evaluate (overloaded for Array parameters).

Parameters

equation	Equation object from Python
x	x-coordinates within the expression
y	y-coordinates within the expression
z	z-coordinates within the expression

Returns

Array containing values of evaluated expression.

Definition at line 130 of file Python/BasicUtils/Equation.cpp.

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

References Nektar::UnitTests::z().

Referenced by export_Equation().

Equation_Evaluate4()

Array< OneD, NekDouble > Equation_Evaluate4	(	std::shared_ptr< Equation >	equation,
		const Array< OneD, const NekDouble > &	x,
		const Array< OneD, const NekDouble > &	y,
		const Array< OneD, const NekDouble > &	z,
		const NekDouble	t
	)

Wrapper for Equation::Evaluate (overloaded for Array parameters + constant time).

Parameters

equation	Equation object from Python
x	x-coordinates within the expression
y	y-coordinates within the expression
z	z-coordinates within the expression
t	Value of time

Returns

Array containing values of evaluated expression.

Definition at line 152 of file Python/BasicUtils/Equation.cpp.

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

References Nektar::UnitTests::z().

Referenced by export_Equation().

Equation_Evaluate5()

Array< OneD, NekDouble > Equation_Evaluate5	(	std::shared_ptr< Equation >	equation,
		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 Equation::Evaluate (overloaded for Array parameters + Array time).

Parameters

equation	Equation object from Python
x	x-coordinates within the expression
y	y-coordinates within the expression
z	z-coordinates within the expression
t	Time values within the expression.

Returns

Array containing values of evaluated expression.

Definition at line 175 of file Python/BasicUtils/Equation.cpp.

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

References Nektar::UnitTests::z().

Referenced by export_Equation().

Equation_SetConstants()

void Equation_SetConstants	(	std::shared_ptr< Equation >	equation,
		py::args	args,
		const py::kwargs &	kwargs
	)

Wrapper for Equation::SetConstants.

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/BasicUtils/Equation.cpp.

{
    // Map that will be passed to C++.
    std::map<std::string, NekDouble> constants;
 
    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;
    }
 
    equation->SetConstants(constants);
}

Referenced by export_Equation().

export_Equation()

void export_Equation

(

py::module &

m

)

Definition at line 186 of file Python/BasicUtils/Equation.cpp.

{
    py::class_<Equation, std::shared_ptr<Equation>>(m, "Equation")
 
        .def(py::init(&ConstructEquation))
 
        .def("Evaluate", Equation_Evaluate1)
        .def("Evaluate", Equation_Evaluate2)
        .def("Evaluate", Equation_Evaluate3)
        .def("Evaluate", Equation_Evaluate4)
        .def("Evaluate", Equation_Evaluate5)
 
        .def("SetParameter", &Equation::SetParameter)
        .def("SetConstants", &Equation_SetConstants)
        .def("GetExpression", &Equation::GetExpression)
        .def("GetVlist", &Equation::GetVlist)
 
        .def("GetTime", &Equation::GetTime);
}

References ConstructEquation(), Equation_Evaluate1(), Equation_Evaluate2(), Equation_Evaluate3(), Equation_Evaluate4(), Equation_Evaluate5(), and Equation_SetConstants().

Referenced by PYBIND11_MODULE().