Documentation Center

  • Trial Software
  • Product Updates

linalg::potential

The (scalar) potential of a gradient field

    Note:   linalg::potential will be removed in a future release. Use potential instead.

Use only in the MuPAD Notebook Interface.

This functionality does not run in MATLAB.

Syntax

linalg::potential(f, [x1, x2, …], <[y1, y2, …]>, <Test>)

Description

linalg::potential(f, x) determines whether the vector field is a gradient field of some scalar potential p with respect to the variables , and computes that potential if it exists.

linalg::potential and potential are equivalent. See details and examples on the potential help page.

Parameters

f

The vector field: a list of arithmetical expressions, or a vector of such expressions. A vector is an n×1 or 1 ×n matrix of a domain of category Cat::Matrix.

x1, x2, …

The variables: identifiers or indexed identifiers

y1, y2, …

The components of the "base point:" arithmetical expressions. If a base point is specified, the returned potential p satisfies .

Options

Test

linalg::potential only checks whether the vector field has a potential and returns TRUE or FALSE, respectively.

Return Values

Arithmetical expression or a Boolean value.

Was this topic helpful?