Bounding elements

This is the module that contains the bounding elements of the DFN.

Notes

This module contains the bounding classes.

class andfn.bounding.BoundingCircle(label, radius, frac0, ncoef=5, nint=10, **kwargs)

Bases: Element

__init__(label, radius, frac0, ncoef=5, nint=10, **kwargs)

Initializes the bounding circle class.

Parameters:

• label (str or int) – The label of the bounding circle.

• r (float) – The radius of the bounding circle.

• ncoef (int) – The number of coefficients in the asymptotic expansion.

• nint (int) – The number of integration points.

• frac (Fracture) – The fracture object that the bounding circle is associated with.

calc_omega(z)

Calculates the omega for the bounding circle.

Parameters:

z (complex | np.ndarray) – A point in the complex z plane.

Returns:

omega – The complex potential for the bounding circle.

Return type:

complex

calc_w(z)

Calculates the complex discharge vector for the bounding circle.

Parameters:

z (complex) – A point in the complex z plane.

Returns:

w – The complex discharge vector for the bounding circle.

Return type:

complex

check_boundary_condition(n=10)

Check if the bounding circle satisfies the boundary conditions.

Parameters:

n (int) – The number of points to check the boundary condition at.

Returns:

The error in the boundary condition.

Return type:

float

find_branch_cuts()

Find the branch cuts for the fracture.

get_chi(z)

Get the chi for the bounding circle.

Parameters:

z (complex | np.ndarray) – A point in the complex z plane.

Returns:

chi – The complex chi for the bounding circle.

Return type:

complex | np.ndarray

get_dpsi_corr()

Get the correction to the stream function for the branch cuts.

Returns:

The correction to the stream function.

Return type:

np.ndarray

solve()

Solve the coefficients of the bounding circle.