GitHub

API

VEM.AbstractVortexBlob — Type
AbstractVortexBlob{Dimension, Scalar <: AbstractFloat}

Abstract type representing a vortex blob in Dimension-dimensional space, parameterized by a floating-point type Scalar.

source
VEM.GaussianVortexBlob — Type
GaussianVortexBlob(circulation::Scalar, center::SA.SVector{Dimension, Scalar}, radius::Scalar) where {Dimension, Scalar}

A smooth vortex blob with a Gaussian distribution of vorticity. It is characterized by the amount of circulation it carries, a position and a finite core radius.

Arguments

  • circulation::Scalar: The circulation strength of the vortex blob.
  • center::SA.SVector{Dimension, Scalar}: The position of the blob.
  • radius::Scalar: The core radius of the blob.

Returns

A GaussianVortexBlob instance.

source
VEM.GaussianVortexBlob — Method
GaussianVortexBlob(circulation, center::AbstractVector, radius)

Constructor for GaussianVortexBlob when center is supplied as <:AbstractVector.

Arguments

  • circulation: The circulation strength of the vortex blob.
  • center::AbstractVector: The position of the blob.
  • radius: The core radius of the blob.

Returns

A GaussianVortexBlob instance.

source
VEM.GaussianVortexBlob — Method
GaussianVortexBlob(circulation, center::SA.SVector, radius)

Constructor for GaussianVortexBlob when center is supplied as SA.SVector.

Arguments

  • circulation: The circulation strength of the vortex blob.
  • center::SA.SVector: The position of the blob.
  • radius: The core radius of the blob.

Returns

A GaussianVortexBlob instance.

source
VEM.GaussianVortexBlob — Method
GaussianVortexBlob(circulation, center::Tuple, radius)

Constructor for GaussianVortexBlob when center is supplied as Tuple.

Arguments

  • circulation: The circulation strength of the vortex blob.
  • center::Tuple: The position of the blob.
  • radius: The core radius of the blob.

Returns

A GaussianVortexBlob instance.

source
VEM.blob_center! — Method
blob_center!(blob::AbstractVortexBlob, new_center)

Update the position of the vortex blob.

Arguments

  • blob::AbstractVortexBlob: The vortex blob.
  • new_center: The new vortex blob position.
source
VEM.blob_center — Method
blob_center(blob::AbstractVortexBlob)

Return the position of the vortex blob.

Arguments

  • blob::AbstractVortexBlob: The vortex blob.

Returns

The position of the vortex blob.

source
VEM.blob_circulation! — Method
blob_circulation!(blob::AbstractVortexBlob, new_circulation)

Update the circulation of the vortex blob.

Arguments

  • blob::AbstractVortexBlob: The vortex blob.
  • new_circulation: The new circulation strength.
source
VEM.blob_circulation — Method
blob_circulation(blob::AbstractVortexBlob)

Return the circulation carried by the vortex blob.

Arguments

  • blob::AbstractVortexBlob: The vortex blob.

Returns

The circulation of the vortex blob.

source
VEM.blob_dimension — Method
blob_dimension(blob::AbstractVortexBlob)

Return the spatial dimension of the given vortex blob.

Arguments

  • blob::AbstractVortexBlob: The vortex blob.

Returns

The spatial dimension of the vortex blob.

source
VEM.blob_radius! — Method
blob_radius!(blob::AbstractVortexBlob, new_radius)

Update the core radius of the vortex blob.

Arguments

  • blob::AbstractVortexBlob: The vortex blob.
  • new_radius: The new core radius.
source
VEM.blob_radius — Method
blob_radius(blob::AbstractVortexBlob)

Return the core radius of the vortex blob.

Arguments

  • blob::AbstractVortexBlob: The vortex blob.

Returns

The core radius of the vortex blob.

source
VEM.blob_scalar — Method
blob_scalar(blob::AbstractVortexBlob)

Return the floating-point type used for the data of the given vortex blob.

Arguments

  • blob::AbstractVortexBlob: The vortex blob.

Returns

The floating-point type of the vortex blob data.

source
VEM.induced_velocity — Method
induced_velocity(blob::GaussianVortexBlob{2}, target)

Compute the velocity induced at target due to a 2D Gaussian vortex blob.

Arguments

  • blob::GaussianVortexBlob{2}: The vortex blob.
  • target: The target position.

Returns

The induced velocity at target.

source
VEM.induced_vorticity — Method
induced_vorticity(blob::GaussianVortexBlob{2}, target)

Compute the vorticity induced at target due to a 2D Gaussian vortex blob.

Arguments

  • blob::GaussianVortexBlob{2}: The vortex blob.
  • target: The target position.

Returns

The induced vorticity at target.

source