OSAFT Module

Solutions for the ARF

Plotting

Core Modules

Backgroundfields

BackgroundField

BackgroundField class which is a base class for all background field classes

Materials

Fluids

Inheritance diagram of fluids

InviscidFluid

Class for an inviscid fluid

ViscousFluid

Class for a viscous fluid

ViscoelasticFluid

Class for a viscoelastic fluid

Solids

Inheritance diagram of solids

RigidSolid

RigidSolid class

ElasticSolid

ElasticSolid class

Composites

Inheritance diagram of basecomposite

Frequency

Frequency class

Sphere

Sphere class

BaseFrequencyComposite

Base class for all composite classes with Frequency

BaseSphereFrequencyComposite

Composite class with Frequency and Sphere

Variable

Inheritance diagram of variable

BaseVariable

BaseVariable class defining basic methods and attributes shared between active and passive attributes.

PassiveVariable

Passive variable without any computation dependencies

ActiveVariable

Variables that depended on at least one BaseVariable

Helper

StringFormatter

Consistent Formatting for __str__ and __repr__ methods

InputHandler

Handles inputs for velocity field methods

Functions

BesselFunctions

This class gathers all reoccurring spherical hankel and bessel functions necessary for the osaft package.

LegendreFunctions

This class gathers all reoccurring Legendre Functions necessary for the osaft package.

full_range

Returns the range including the end point.

integrate

Integrates func between lower and upper Scipy's QUADPACK implementation quad() .

integrate_osc

Special purpose integrator for oscillating integrals that integrates func between lower and upper.

spherical_2_cartesian_vector

Transforms velocities in the Spherical coordinate system (v_r, v_theta) of an axisymmetric model to the Cartesian system (v_x, v_z).

cartesian_2_spherical_vector

Transforms velocities in the a Spherical coordinate system (v_r, v_theta) of an axisymmetric model to the Cartesian system (v_x, v_z).

cartesian_2_spherical_coordinates

Transforms Cartesian coordinates (x z) of an axisymmetric model into spherical coordinates (r, theta).

spherical_2_cartesian_coordinates

Transforms spherical coordinates (r theta) of an axisymmetric model into Cartesian coordinates (x, z).

clebsch_gordan_coefficient

Clebsch-Gordan coefficient for integer valued arguments.

xexpexp1

Computes \(z\exp(z)E_1(z)\)

Enums, Exceptions, and Warnings

Enums

final class osaft.core.backgroundfields.WaveType(value)[source]

Supported Wavetypes for the acoustic background field

STANDING: Plane standing wave

TRAVELLING: Plane travelling wave

Exceptions

exception osaft.core.backgroundfields.WrongWaveTypeError(msg=None, *args, **kwargs)[source]

Exception for using the wrong Wave type

Warnings

class osaft.core.warnings.AssumptionWarning[source]

Warning that the used solution might not be valid based on the set material parameters

osaft.core.warnings.raise_assumption_warning

Raises AssumptionWarning if test is True