vc_curl: Estimate the Cartesian curl of a spatial vector field

View source: R/vector_fields.R

vc_curlR Documentation

Estimate the Cartesian curl of a spatial vector field

Description

Estimate the Cartesian curl of a spatial vector field

Usage

vc_curl(
  f,
  point,
  method = "central",
  h = NULL,
  atol = 1e-08,
  rtol = 1e-04,
  warn = TRUE
)

Arguments

f

Function of a Cartesian vector returning three finite real components.

point

Finite real Cartesian vector of length three.

method

One difference method, or one per coordinate. Explicit one-sided methods can be used at known coordinate-domain boundaries.

h

NULL for per-coordinate vc_derivative heuristics, one positive finite step for all coordinates, or a positive finite vector of that dimension. No recycling of shorter vectors is allowed.

atol

Nonnegative finite absolute tolerance for sensitivity comparisons.

rtol

Nonnegative finite relative tolerance for sensitivity comparisons.

warn

Logical scalar; warn when sensitivity diagnostics fail.

Details

Curl uses the right-handed Cartesian convention. Reliability summarizes the two partial derivatives used per component. To evaluate a time-dependent field at fixed time, capture that time in f.

Value

List with estimate, refinements, component reliability and full Jacobian.

Examples

vc_curl(function(p)c(-p[2],p[1],0),c(1,2,0))$estimate

vectorialcalculus documentation built on Nov. 17, 2026, 1:09 a.m.