jaxfluids.stencils.levelset package

Submodules

jaxfluids.stencils.levelset.deriv_first_order module

class jaxfluids.stencils.levelset.deriv_first_order.DerivativeFirstOrderSided(nh: int, inactive_axis: List, offset: int = 0)[source]

Bases: SpatialDerivative

derivative_xi(levelset: Array, dxi: Array, i: int, j: int, *args) → Array[source]

Calculates the derivative in the direction indicated by axis.

Parameters:

  • buffer (jnp.ndarray) – Buffer for which the derivative will be calculated

  • dxi (jnp.ndarray) – Cell sizes along axis direction

  • axis (int) – Spatial axis along which derivative is calculated

Returns:

Buffer with numerical derivative

Return type:

jnp.ndarray

jaxfluids.stencils.levelset.deriv_first_order_subcell_fix module

class jaxfluids.stencils.levelset.deriv_first_order_subcell_fix.DerivativeFirstOrderSidedSubcellFix(nh: int, inactive_axis: List, offset: int = 0)[source]

Bases: SpatialDerivative

derivative_xi(levelset: Array, dxi: Array, i: int, j: int, levelset_0: Array, distance: Array) → Array[source]

Calculates the derivative in the direction indicated by axis.

Parameters:

  • buffer (jnp.ndarray) – Buffer for which the derivative will be calculated

  • dxi (jnp.ndarray) – Cell sizes along axis direction

  • axis (int) – Spatial axis along which derivative is calculated

Returns:

Buffer with numerical derivative

Return type:

jnp.ndarray

jaxfluids.stencils.levelset.houc3 module

class jaxfluids.stencils.levelset.houc3.HOUC3(nh: int, inactive_axis: List)[source]

Bases: SpatialDerivative

derivative_xi(levelset: Array, dxi: float, i: int, j: int, *args) → Array[source]

Calculates the derivative in the direction indicated by axis.

Parameters:

  • buffer (jnp.ndarray) – Buffer for which the derivative will be calculated

  • dxi (jnp.ndarray) – Cell sizes along axis direction

  • axis (int) – Spatial axis along which derivative is calculated

Returns:

Buffer with numerical derivative

Return type:

jnp.ndarray

jaxfluids.stencils.levelset.houc5 module

class jaxfluids.stencils.levelset.houc5.HOUC5(nh: int, inactive_axis: List)[source]

Bases: SpatialDerivative

derivative_xi(levelset: Array, dxi: float, i: int, j: int, *args) → Array[source]

Calculates the derivative in the direction indicated by axis.

Parameters:

  • buffer (jnp.ndarray) – Buffer for which the derivative will be calculated

  • dxi (jnp.ndarray) – Cell sizes along axis direction

  • axis (int) – Spatial axis along which derivative is calculated

Returns:

Buffer with numerical derivative

Return type:

jnp.ndarray

jaxfluids.stencils.levelset.houc7 module

class jaxfluids.stencils.levelset.houc7.HOUC7(nh: int, inactive_axis: List)[source]

Bases: SpatialDerivative

derivative_xi(levelset: Array, dxi: float, i: int, j: int, *args) → Array[source]

Calculates the derivative in the direction indicated by axis.

Parameters:

  • buffer (jnp.ndarray) – Buffer for which the derivative will be calculated

  • dxi (jnp.ndarray) – Cell sizes along axis direction

  • axis (int) – Spatial axis along which derivative is calculated

Returns:

Buffer with numerical derivative

Return type:

jnp.ndarray

jaxfluids.stencils.levelset.weno3_deriv module

class jaxfluids.stencils.levelset.weno3_deriv.WENO3DERIV(nh: int, inactive_axis: List, face_value: str = 'right')[source]

Bases: SpatialDerivative

derivative_xi(levelset: Array, dx: float, i: int, j: int, *args) → Array[source]

Calculates the derivative in the direction indicated by axis.

Parameters:

  • buffer (jnp.ndarray) – Buffer for which the derivative will be calculated

  • dxi (jnp.ndarray) – Cell sizes along axis direction

  • axis (int) – Spatial axis along which derivative is calculated

Returns:

Buffer with numerical derivative

Return type:

jnp.ndarray

jaxfluids.stencils.levelset.weno5_deriv module

class jaxfluids.stencils.levelset.weno5_deriv.WENO5DERIV(nh: int, inactive_axis: List, face_value: str = 'right')[source]

Bases: SpatialDerivative

derivative_xi(levelset: Array, dx: int, i: int, j: int, *args) → Array[source]

Calculates the derivative in the direction indicated by axis.

Parameters:

  • buffer (jnp.ndarray) – Buffer for which the derivative will be calculated

  • dxi (jnp.ndarray) – Cell sizes along axis direction

  • axis (int) – Spatial axis along which derivative is calculated

Returns:

Buffer with numerical derivative

Return type:

jnp.ndarray

Module contents