CADETProcess.solution.SolutionSolid#

class CADETProcess.solution.SolutionSolid(name, time, component_system, solution, c_min)[source]#

Bases: SolutionBase

Solution in the particle solid phase of the UnitOperation.

Dimensions: NCOL * NRAD * sum_{j}^{NPARTYPE}{NBOUND,j * NPAR,j}

dimensions = ['time', 'axial_coordinates', 'radial_coordinates', 'particle_coordinates', 'component_coordinates']#
property n_bound: int#

int: Number of bound states.

property n_comp: int#

int: Number of bound states.

property ncol: int#

int: Number of axial discretization points.

property npar: int#

int: Number of particle 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]][source]#

Plot the entire particle solid phase 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_time(t: float, comp: int | None = None, bound_state: int | None = 0, vmax: float | None = None, *args: Any, **kwargs: Any) tuple[Figure, Axes | tuple[Axes]][source]#

Plot particle solid solution for a given bound state over space at given time.

Parameters:
tfloat

Solution time at with to plot.

compOptional[int]

Component index.

bound_stateOptional[int], default=0

Bound state index.

vmax: Optional[float]

Maximum data value to scale color map.

*argsAny

Optional arguments passed to the local plot methods.

**kwargsAny

Optional keyword arguments passed to the local plot methods.

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

The Matplotlib Figure and Axes objects.