floripy.hydrodynamics package#

Submodules#

floripy.hydrodynamics.ellipsoid_rf module#

floripy.hydrodynamics.ellipsoid_rf.get_force_torque_prolate(a, c, d, u_inf, omega_inf, E_inf)[source]#

floripy.hydrodynamics.ellipsoid_rf.get_force_torque_oblate(a, c, d, u_inf, omega_inf, E_inf)[source]#

floripy.hydrodynamics.ellipsoid_rf.get_force_torque_ellipsoid(a, b, c, dcm, u_inf, omega_inf, E_inf)[source]#

floripy.hydrodynamics.ellipsoids module#

class floripy.hydrodynamics.ellipsoids.Ellipsoids_hydrodynamics(model, flowfield, kwargs)[source]#

Bases: HydrodynamicsBase

Methods

`getrans_gmm_ge`(ge[, out])	Returns the product A'MA, where A is a matrix, M is the mobility matrix for force and torque, and A' is the transpose of A.
`getrans_grm_ge`(ge[, out])	Returns the product A'RA, where A is a matrix, R is the resistance matrix for force and torque, and A' is the transpose of A.
`gmm_cholesky_decomp`()	Returns the Cholesky decomposition of the grand mobility matrix.
`gmmvec`(vec[, out])	Returns the product of the grand mobility matrix with another numpy vector.
`gmmvel`([out])	Returns the product of the grand mobility matrix with the fluid velocity at the given points.
`grm_cholesky_decomp`()	Returns the Cholesky decomposition of the grand resistance matrix.
`grmvec`(vec[, out])	Returns the product of the grand resistance matrix with another numpy vector.
`grmvel`([out])	Returns the product of the grand resistance matrix with the fluid velocity at the given points.

update

update(time)[source]#

getrans_gmm_ge(ge, out=None)#: Returns the product A’MA, where A is a matrix, M is the mobility matrix for force and torque, and A’ is the transpose of A.

getrans_grm_ge(ge, out=None)#: Returns the product A’RA, where A is a matrix, R is the resistance matrix for force and torque, and A’ is the transpose of A.

gmm_cholesky_decomp()#: Returns the Cholesky decomposition of the grand mobility matrix.

gmmvec(vec, out=None)#: Returns the product of the grand mobility matrix with another numpy vector.

gmmvel(out=None)#: Returns the product of the grand mobility matrix with the fluid velocity at the given points.

grm_cholesky_decomp()#: Returns the Cholesky decomposition of the grand resistance matrix.

grmvec(vec, out=None)#: Returns the product of the grand resistance matrix with another numpy vector.

grmvel(out=None)#: Returns the product of the grand resistance matrix with the fluid velocity at the given points.

floripy.hydrodynamics.hydrodynamicsbase module#

class floripy.hydrodynamics.hydrodynamicsbase.HydrodynamicsBase[source]#

Bases: object

Methods

`getrans_gmm_ge`(ge[, out])	Returns the product A'MA, where A is a matrix, M is the mobility matrix for force and torque, and A' is the transpose of A.
`getrans_grm_ge`(ge[, out])	Returns the product A'RA, where A is a matrix, R is the resistance matrix for force and torque, and A' is the transpose of A.
`gmm_cholesky_decomp`()	Returns the Cholesky decomposition of the grand mobility matrix.
`gmmvec`(vec[, out])	Returns the product of the grand mobility matrix with another numpy vector.
`gmmvel`([out])	Returns the product of the grand mobility matrix with the fluid velocity at the given points.
`grm_cholesky_decomp`()	Returns the Cholesky decomposition of the grand resistance matrix.
`grmvec`(vec[, out])	Returns the product of the grand resistance matrix with another numpy vector.
`grmvel`([out])	Returns the product of the grand resistance matrix with the fluid velocity at the given points.

update

abstractmethod update(time)[source]#

grmvec(vec, out=None)[source]#: Returns the product of the grand resistance matrix with another numpy vector.

gmmvec(vec, out=None)[source]#: Returns the product of the grand mobility matrix with another numpy vector.

grmvel(out=None)[source]#: Returns the product of the grand resistance matrix with the fluid velocity at the given points.

gmmvel(out=None)[source]#: Returns the product of the grand mobility matrix with the fluid velocity at the given points.

getrans_grm_ge(ge, out=None)[source]#: Returns the product A’RA, where A is a matrix, R is the resistance matrix for force and torque, and A’ is the transpose of A.

getrans_gmm_ge(ge, out=None)[source]#: Returns the product A’MA, where A is a matrix, M is the mobility matrix for force and torque, and A’ is the transpose of A.

grm_cholesky_decomp()[source]#: Returns the Cholesky decomposition of the grand resistance matrix.

gmm_cholesky_decomp()[source]#: Returns the Cholesky decomposition of the grand mobility matrix.

floripy.hydrodynamics.oblates module#

class floripy.hydrodynamics.oblates.Oblates_hydrodynamics(model, flowfield, kwargs)[source]#

Bases: HydrodynamicsBase

Methods

`getrans_gmm_ge`(ge[, out])	Returns the product A'MA, where A is a matrix, M is the mobility matrix for force and torque, and A' is the transpose of A.
`getrans_grm_ge`(ge[, out])	Returns the product A'RA, where A is a matrix, R is the resistance matrix for force and torque, and A' is the transpose of A.
`gmm_cholesky_decomp`()	Returns the Cholesky decomposition of the grand mobility matrix.
`gmmvec`(vec[, out])	Returns the product of the grand mobility matrix with another numpy vector.
`gmmvel`([out])	Returns the product of the grand mobility matrix with the fluid velocity at the given points.
`grm_cholesky_decomp`()	Returns the Cholesky decomposition of the grand resistance matrix.
`grmvec`(vec[, out])	Returns the product of the grand resistance matrix with another numpy vector.
`grmvel`([out])	Returns the product of the grand resistance matrix with the fluid velocity at the given points.

update

update(time)[source]#

getrans_gmm_ge(ge, out=None)#: Returns the product A’MA, where A is a matrix, M is the mobility matrix for force and torque, and A’ is the transpose of A.

getrans_grm_ge(ge, out=None)#: Returns the product A’RA, where A is a matrix, R is the resistance matrix for force and torque, and A’ is the transpose of A.

gmm_cholesky_decomp()#: Returns the Cholesky decomposition of the grand mobility matrix.

gmmvec(vec, out=None)#: Returns the product of the grand mobility matrix with another numpy vector.

gmmvel(out=None)#: Returns the product of the grand mobility matrix with the fluid velocity at the given points.

grm_cholesky_decomp()#: Returns the Cholesky decomposition of the grand resistance matrix.

grmvec(vec, out=None)#: Returns the product of the grand resistance matrix with another numpy vector.

grmvel(out=None)#: Returns the product of the grand resistance matrix with the fluid velocity at the given points.

floripy.hydrodynamics.prolates module#

class floripy.hydrodynamics.prolates.Prolates_hydrodynamics(model, flowfield, kwargs)[source]#

Bases: object

Methods

update

update(time)[source]#

floripy.hydrodynamics.spheres module#

class floripy.hydrodynamics.spheres.Spheres_hydrodynamics(model, flowfield, kwargs)[source]#

Bases: HydrodynamicsBase

Methods

`getrans_gmm_ge`(ge[, out])	Returns the product A'MA, where A is a matrix, M is the mobility matrix for force and torque, and A' is the transpose of A.
`getrans_grm_ge`(ge[, out])	Returns the product A'RA, where A is a matrix, R is the resistance matrix for force and torque, and A' is the transpose of A.
`gmm_cholesky_decomp`()	Returns the Cholesky decomposition of the grand mobility matrix.
`gmmvec`(vec[, out])	Returns the product of the grand mobility matrix with another numpy vector.
`gmmvel`([out])	Returns the product of the grand mobility matrix with the fluid velocity at the given points.
`grm_cholesky_decomp`()	Returns the Cholesky decomposition of the grand resistance matrix.
`grmvec`(vec[, out])	Returns the product of the grand resistance matrix with another numpy vector.
`grmvel`([out])	Returns the product of the grand resistance matrix with the fluid velocity at the given points.
`update`(time)	Update the flowfield if required.

update(time)[source]#: Update the flowfield if required.

getrans_gmm_ge(ge, out=None)#: Returns the product A’MA, where A is a matrix, M is the mobility matrix for force and torque, and A’ is the transpose of A.

getrans_grm_ge(ge, out=None)#: Returns the product A’RA, where A is a matrix, R is the resistance matrix for force and torque, and A’ is the transpose of A.

gmm_cholesky_decomp()#: Returns the Cholesky decomposition of the grand mobility matrix.

gmmvec(vec, out=None)#: Returns the product of the grand mobility matrix with another numpy vector.

gmmvel(out=None)#: Returns the product of the grand mobility matrix with the fluid velocity at the given points.

grm_cholesky_decomp()#: Returns the Cholesky decomposition of the grand resistance matrix.

grmvec(vec, out=None)#: Returns the product of the grand resistance matrix with another numpy vector.

grmvel(out=None)#: Returns the product of the grand resistance matrix with the fluid velocity at the given points.

Module contents#

floripy.hydrodynamics.create(model, flowfield, kwargs)[source]#