VectorFunction

VectorFunction(self, *args, **kwargs)

Vector valued space varying Function as a rank 1 tensor of Function.

Attributes

Name	Description
is_TensorValued	bool(x) -> bool
is_VectorValued	bool(x) -> bool
laplace	Laplacian of the VectorFunction, creates the Laplacian VectorFunction.

Methods

Name	Description
curl	Gradient of the (3D) VectorFunction, creates the curl VectorFunction.
div	Divergence of the VectorFunction, creates the divergence Function.
grad	Gradient of the VectorFunction, creates the gradient TensorFunction.
laplacian	Laplacian of the VectorFunction, creates the Laplacian VectorFunction.

curl

curl(shift=None, order=None, method='FD')

Gradient of the (3D) VectorFunction, creates the curl VectorFunction.

Parameters

Name	Type	Description	Default
shift		Shift for the center point of the derivative in number of gridpoints	None
order		Discretization order for the finite differences. Uses func.space_order when not specified	None
method		Discretization method. Options are ‘FD’ (default) and ‘RSFD’ (rotated staggered grid finite-difference).	'FD'

div

div(shift=None, order=None, method='FD')

Divergence of the VectorFunction, creates the divergence Function.

Parameters

Name	Type	Description	Default
shift		Shift for the center point of the derivative in number of gridpoints	None
order		Discretization order for the finite differences. Uses func.space_order when not specified	None
method		Discretization method. Options are ‘FD’ (default) and ‘RSFD’ (rotated staggered grid finite-difference).	'FD'

grad

grad(shift=None, order=None, method='FD')

Gradient of the VectorFunction, creates the gradient TensorFunction.

Parameters

Name	Type	Description	Default
shift		Shift for the center point of the derivative in number of gridpoints	None
order		Discretization order for the finite differences. Uses func.space_order when not specified	None
method		Discretization method. Options are ‘FD’ (default) and ‘RSFD’ (rotated staggered grid finite-difference).	'FD'

laplacian

laplacian(shift=None, order=None)

Laplacian of the VectorFunction, creates the Laplacian VectorFunction.

Parameters

Name	Type	Description	Default
shift		Shift for the center point of the derivative in number of gridpoints	None
order		Discretization order for the finite differences. Uses func.space_order when not specified	None