ARFPlot#

Examples using this class are:

Acoustofluidics 2022: ARF Comparison

Frontiers: Air Bubble in Water

Frontiers: Copper Particle in Viscous Oil

Frontiers: HFE Droplet in Water

Doinikov Rigid (1994): Sandstone in Glycerin

Hasegawa (1979) Figure 3

Yosioka and Kawasima (1955) Figure 2

Doinikov 1994 Models

Doinikov 2021 Viscous - Convergence Study

Multicore ARF Computation

Possible Numerical Problems

class osaft.plotting.arf.arf_plots.ARFPlot(attr_name=None, x_values=None)[source]#

Bases: object

Plotting different ARF solutions inside same axis over attribute

Parameters:

attr_name (None | str, optional) – name of attribute for x-axis
Default: None
x_values (None | NDArray, optional) – x values for axis
Default: None

Public Data Attributes:

`attr_name`	Attribute that is used as x-axis
`x_values`	Values of x-axis

Public Methods:

`set_abscissa`(x_values, attr_name)	Setting the abscissa variable and values for the ARF plot
`add_solutions`(*solutions[, multicore])	Add solutions to list of solutions for plotting e.g.
`remove_solution`(solution)	Remove solution of list of solutions for plotting
`plot_solutions`([ax, display_values, ...])	Plot all solutions in stack over attribute set via `set_abscissa()` or over `x_values` if passed using the plotting methods `plot_method`.

add_solutions(*solutions, multicore=False)[source]#

Add solutions to list of solutions for plotting e.g. osaft.king1934.ARF()

Parameters:

solutions (BaseARF) – one or multiple solutions, e.g. osaft.king1934.ARF()
multicore (bool, optional) – it True, multiple processing
Default: False

Return type:

None

plot_solutions(ax=None, display_values=None, normalization=None, plot_method=<function plot>, **kwargs)[source]#

Plot all solutions in stack over attribute set via set_abscissa() or over x_values if passed using the plotting methods plot_method. The plot can be normalized if one of the following is passed as normalization:

the name of an added solution:

'max': normalization w.r.t. max value of the ARF in the plot

a float: normalization w.r.t. to a number

a callable normalization w.r.t. to function that takes the values on the x-axis as an input

Parameters:

ax (None | plt.Axes, optional) – axes object where plot will be generated
Default: None
display_values (None | Sequence, optional) – changing the values for the x-axis
Default: None
normalization (None | str | float | Callable[[float], float], optional) – normalization (see above)
Default: None
plot_method (optional) – matplotlib native plotting method (e.g.plt.loglog)
Default: <function plot>
kwargs – keyword arguments that get piped to plot_method

Return type:

(plt.Figure, plt.Axes)

remove_solution(solution)[source]#

Remove solution of list of solutions for plotting

Parameters:: solution (BaseARF) – specific ARF solution, e.g. osaft.king1932.ARF()
Return type:: None

set_abscissa(x_values, attr_name)[source]#

Setting the abscissa variable and values for the ARF plot

Parameters:

x_values (ndarray) – data points to be plotted over
attr_name (str) – name of the dependent variable to be plotted over

Return type:

None

property attr_name: str#

Attribute that is used as x-axis

Getter:: returns the attribute name for the x-axis
Setter:: sets attribute name

property x_values: ndarray#

Values of x-axis

Getter:: returns x-axis values
Setter:: sets x-axis values