morphogen.rve.report

Reports of RVE studies: Markdown, LaTeX (booktabs), JSON and figures.

The tables follow Dirrenberger et al. (2014): realizations per volume (Table 3), mean values with [Zbar - 2 D_Z, Zbar + 2 D_Z] and bounds (Table 4), statistical isotropy (Tables 5-7), relative errors (Table 8), fitted exponents (Table 9) and RVE sizes (Table 10), plus the discrepancy between boundary conditions (eq. 69) and the number of realizations needed per volume. Volumes are printed as L^3, the areas of the square windows of a planar image as L^2, and the edges of the RVE sizes are V^(1/3) (the side A^(1/2) of a square of area A).

When the realizations have their apparent stiffness (TensorStatistics), each boundary condition adds the tables of the mean stiffness Cbar_ij +/- 2 D and of the compliance S_ij = Cbar^-1 +/- 2 D per volume (every component of the upper triangle, Voigt order 11 22 33 23 31 12 with engineering shears), the RVE sizes of their components, the figure rve_stiffness_<bc>.png (the components against the volume, their relative scatter and its fits) and the table rve_stiffness.csv (one row per condition and volume: C11 … C66, S11 … S66 and their standard deviations C11_std …). The conductivity tensor likewise, with its inverse the resistivity (rve_conductivity_tensor.csv, the axes 1 2 3); by the window method (morphogen.rve.windows) the tables count the windows of each size, whose tensors are their mean mutual energies, as n x T with T tilings shifted around the periodic realization (n the windows of one, the count of the uncertainties).

morphogen.rve.report.series_label(analysis) → str[source]

The label of an analysed series: its property, with its boundary conditions if any.

morphogen.rve.report.tables(report: StudyReport) → list[tuple[str, list[str], list[list[str]], str]][source]

The report tables as (title, header, rows, note): those of the series, then those of the mean stiffness and compliance of each boundary condition (tensor_tables()).

morphogen.rve.report.tensor_label(t: TensorStatistics) → str[source]

The label of the mean tensor of a boundary condition: stiffness (PBC).

morphogen.rve.report.tensor_tables(t: TensorStatistics, options: StudyOptions | None = None) → list[tuple[str, list[str], list[list[str]], str]][source]

The tables of the mean stiffness and compliance of a boundary condition, as (title, header, rows, note): each component of Cbar and of S = Cbar^-1 per volume (mean +/- 2 D), then the RVE sizes of the components that have one (of a conductivity and its resistivity likewise; per window size by the window method).

morphogen.rve.report.markdown(report: StudyReport, title: str | None = None) → str[source]

The Markdown report of an RVE study: the point variance and integral range of each property, then the tables of the study.

morphogen.rve.report.latex(report: StudyReport) → str[source]

The tables in LaTeX (booktabs package).

morphogen.rve.report.plot(report: StudyReport, outdir: Path) → list[Path][source]

Figures per property: variance, mean +/- 2 D_Z and RVE size (needs matplotlib), against the volumes, or the areas of the squares of a planar image.

morphogen.rve.report.write(report: StudyReport, outdir, *, stem: str = 'rve_report', figures: bool = True) → list[Path][source]

Write <stem>.json, .md and .tex (and the figures) in outdir, and rve_<tensor>.csv (the mean stiffness and compliance per boundary condition and volume, volume_rows()) when the study has them.