Skip to content
Symi Docs
Python
On this page

Vector calculus

Coordinates are passed as a list of variable names; vector fields as a list of component expressions in the same order. Empty variable lists and component/variable count mismatches raise.

gradient#

Default context

gradient(
    scalar_field: ExpressionLike,
    variables: Iterable[VariableLike],
) -> list[Expression]
Calling forms

Explicit context: Context.gradient

gradient(
    scalar_field: ExpressionLike,
    variables: Iterable[VariableLike],
) -> list[Expression]

∇f\nabla f: the partial derivatives in the order of variables.

divergence#

Default context

divergence(
    vector_components: Iterable[ExpressionLike],
    variables: Iterable[VariableLike],
) -> Expression
Calling forms

Explicit context: Context.divergence

divergence(
    vector_components: Iterable[ExpressionLike],
    variables: Iterable[VariableLike],
) -> Expression

∇⋅F=∑i∂Fi/∂xi\nabla\cdot F = \sum_i \partial F_i/\partial x_i; component and variable counts must match.

curl#

Default context

curl(
    vector_components: Iterable[ExpressionLike],
    variables: Iterable[VariableLike],
) -> list[Expression]
Calling forms

Explicit context: Context.curl

curl(
    vector_components: Iterable[ExpressionLike],
    variables: Iterable[VariableLike],
) -> list[Expression]

∇×F\nabla\times F. Requires exactly three components and three variables; other dimensions raise.

laplacian#

Default context

laplacian(
    scalar_field: ExpressionLike,
    variables: Iterable[VariableLike],
) -> Expression
Calling forms

Explicit context: Context.laplacian

laplacian(
    scalar_field: ExpressionLike,
    variables: Iterable[VariableLike],
) -> Expression

Δf=∇⋅∇f\Delta f = \nabla\cdot\nabla f.

jacobian#

Default context

jacobian(
    vector_components: Iterable[ExpressionLike],
    variables: Iterable[VariableLike],
) -> Matrix
Calling forms

Explicit context: Context.jacobian

jacobian(
    vector_components: Iterable[ExpressionLike],
    variables: Iterable[VariableLike],
) -> Matrix

The matrix with entry (i,j)=∂Fi/∂xj(i, j) = \partial F_i/\partial x_j (rows index components, columns index variables). Returned as a Matrix so the result composes with the matrix methods.

hessian#

Default context

hessian(
    scalar_field: ExpressionLike,
    variables: Iterable[VariableLike],
) -> Matrix
Calling forms

Explicit context: Context.hessian

hessian(
    scalar_field: ExpressionLike,
    variables: Iterable[VariableLike],
) -> Matrix

The n×nn\times n matrix of second partials, computed as the Jacobian of the gradient; structurally symmetric on smooth input.

Example#

Differential operators over an ordered coordinate list.

Python
import symi

x = symi.symbol("x")
y = symi.symbol("y")
z = symi.symbol("z")

print(symi.gradient(x**2 * y, ["x", "y"]))
print(symi.divergence([x, y, z], ["x", "y", "z"]))
print(symi.curl([y, -x, 0], ["x", "y", "z"]))
print(symi.laplacian(x**2 + y**2, ["x", "y"]))

Symi documentation · Python