plopm.utils.write_twod module

Utiliy functions to write the 2D figures (PNGs and GIFs)

plopm.utils.write_twod.fill_map_array(cfg: ConfigPlopm, read: ReadData, var: str, quan: ndarray[tuple[Any, ...], dtype[_ScalarT]], slide_index: int, map_index: int, mx: int, my: int, use_csv: bool = False) → ndarray[tuple[Any, ...], dtype[_ScalarT]]: Retrieve the quantity

plopm.utils.write_twod.find_min_max(cfg: ConfigPlopm) → tuple[ReadData, ndarray[tuple[Any, ...], dtype[_ScalarT]], ndarray[tuple[Any, ...], dtype[_ScalarT]], list[float], list[float], list[ndarray[tuple[Any, ...], dtype[_ScalarT]]]]: Method to find the min and max for the colorbars

plopm.utils.write_twod.get_mask(cfg: ConfigPlopm) → list[ndarray[tuple[Any, ...], dtype[_ScalarT]]]: Read the mask

plopm.utils.write_twod.handle_axis(fig: Figure, axiss: Any, cfg: ConfigPlopm, read: ReadData, name: str, n: int, t: int, k: int, n_s: int, unit: str, xc: ndarray[tuple[Any, ...], dtype[_ScalarT]], yc: ndarray[tuple[Any, ...], dtype[_ScalarT]], extinf: float, named: str, deckd: str, defcol: bool, slidet: str, nwelult: int) → None: Method to handle the figure axis

plopm.utils.write_twod.handle_well_or_grid_or_fault(fig: Figure, cfg: ConfigPlopm, imag: _ScalarMappable, divider: AxesDivider, vect: ndarray[tuple[Any, ...], dtype[_ScalarT]], n: int, var: str, welult: list | None, lwelult: list[str]) → None: Method to create the 2d maps using pcolormesh

plopm.utils.write_twod.make_maps(cfg: ConfigPlopm) → None: Method to create the 2d maps using pcolormesh

plopm.utils.write_twod.mapit(t: int, deck: str, fig: Figure, axiss: Any, original_loc: list[Any], cb: list[str], cmin: list[float], cmax: list[float], maska: list[Any], diffa: list[ndarray[tuple[Any, ...], dtype[_ScalarT]]], named: str, deckd: str, slidet: str, sliden: str, cfg: ConfigPlopm, n: int, read: ReadData, xc: ndarray[tuple[Any, ...], dtype[_ScalarT]], yc: ndarray[tuple[Any, ...], dtype[_ScalarT]], skip: int, sub1: int, mx: int, my: int, xname: str, yname: str) → Iterable[Artist]: Method to coordinate the generation of axis

plopm.utils.write_twod.mapits(deck: str, fig: Figure, axiss: Any, original_loc: list[Any], cb: list[Any], cmin: list[float], cmax: list[float], maska: list[Any], diffa: list[ndarray[tuple[Any, ...], dtype[_ScalarT]]], named: str, deckd: str, slidet: str, sliden: str, cfg: ConfigPlopm, read: ReadData, t: int, n: int, k: int, xc: ndarray[tuple[Any, ...], dtype[_ScalarT]], yc: ndarray[tuple[Any, ...], dtype[_ScalarT]], sub1: int, mx: int, my: int, xname: str, yname: str) → None: Generate the spatial maps

plopm.utils.write_twod.prepare_maps(cfg: ConfigPlopm, deck: str, n: int) → tuple[ReadData, ndarray[tuple[Any, ...], dtype[_ScalarT]], ndarray[tuple[Any, ...], dtype[_ScalarT]], str, str, str, int, int, str, str]: Get the spatial coordinates