CADETProcess.solution.SolutionBulk

class CADETProcess.solution.SolutionBulk(name, time, component_system, solution, c_min)

Bases: SolutionBase

Solution in the bulk phase of the UnitOperation.

Dimensions: NCOL * NRAD * NCOMP

dimensions = ['time', 'axial_coordinates', 'radial_coordinates', 'component_coordinates']

property ncol: int

int: Number of axial discretization points.

property nrad: int

int: Number of radial discretization points.

plot(start: float | None = None, end: float | None = None, components: list[str] | None = None, x_axis_in_minutes: bool = True, *args: Any, **kwargs: Any) → tuple[Figure, Axes | tuple[Axes]]

Plot bulk solution for each component.

Parameters:

startfloat | None, optional, default=None

Start time for plotting in seconds. If None, the first data point is used.

endfloat | None, optional, default=None

End time for plotting in seconds. If None, the last data point is used.

componentslist[str] | None, optional, default=None

List of components to be plotted. If None, all components are plotted.

x_axis_in_minutesbool, optional, default=True

If True, the x-axis is displayed in minutes instead of seconds.

*argsAny

Optional arguments passed to _plot_solution_1D.

**kwargsAny

Optional keyword arguments passed to _plot_solution_1D.

Returns:

tuple[plt.Figure, plt.Axes | tuple[plt.Axes]]

The Matplotlib Figure and Axes objects.

Raises:

CADETProcessError

If solution is not 1D.

See also

_plot_solution_1D

Low-level function for 1D plotting.

slice_solution

Slice the solution for plotting.

CADETProcess.plotting

Plotting library utilities.

plot_at_position(z: float, start: float | None = None, end: float | None = None, components: list[str] | None = None, x_axis_in_minutes: bool = True, *args: Any, **kwargs: Any) → tuple[Figure, Axes | tuple[Axes]]

Plot bulk solution over space at given time.

Parameters:

zfloat

Position for plotting.

startfloat | None, optional, default=None

Start time for plotting in seconds. If None, the first data point is used.

endfloat | None, optional, default=None

End time for plotting in seconds. If None, the last data point is used.

componentslist[str] | None, optional, default=None

List of components to be plotted. If None, all components are plotted.

x_axis_in_minutesbool, optional, default=True

If True, the x-axis will be plotted using minutes.

*argsAny

Optional arguments passed to _plot_solution_1D.

**kwargsAny

Optional keyword arguments passed to _plot_solution_1D.

Returns:

tuple[plt.Figure, plt.Axes | tuple[plt.Axes]]

The Matplotlib Figure and Axes objects.

See also

_plot_solution_1D

_plot_2D

slice_solution

CADETProcess.plotting

plot_at_time(t: float, components: list[str] | None = None, *args: Any, **kwargs: Any) → tuple[Figure, Axes | tuple[Axes]]

Plot bulk solution over space at given time.

Parameters:

tfloat

Time for plotting. If t == -1, the final solution is plotted.

componentsOptional[list[str]]

List of components to be plotted. If None, all components are plotted.

*argsAny

Optional arguments passed to _plot_solution_1D.

**kwargsAny

Optional keyword arguments passed to _plot_solution_1D.

Returns:

tuple[plt.Figure, plt.Axes | tuple[plt.Axes]]

The Matplotlib Figure and Axes objects.

See also

_plot_solution_1D

_plot_2D

slice_solution

CADETProcess.plotting