PoreAna 0.2
  • API
  • Sample
  • Density
  • Diffusion (Bin)
  • Diffusion (MC)
  • Further Properties
  • Site
    • Page
        • mc_profile
          • mc_profile()
    • mc_profile
      • mc_profile()
    Source

    mc_profile¶

    poreana.diffusion.mc_profile(link, len_step=[], section=[], infty_profile=True, is_plot=True, is_error=True, kwargs={})¶

    This function plots the diffusion profile for an infinity lag time (\(\Delta t_{\alpha} \rightarrow \infty\)) over the box fitted with the specified \(\mathrm{len}\_\mathrm{step}\) list. Additionally, it is possible to display the diffusion profiles for the calculated lag times. Therefore, the \(\mathrm{infty}\_\mathrm{profile}\) has to be false. The list \(\mathrm{len}\_\mathrm{step}\) contains the calculated step length which should be displayed.

    Parameters:
    linkstring

    Link to the diffusion hdf5 data file generated by the MC Algorithm poreana.mc.MC.run()

    len_stepinteger list, optional

    List of the different step length, if it is [] all diffusion profiles depending on the lag time are used to calculate the diffusion profile for an infinite lag time or the individual diffusion profiles for these lag times are shown

    sectionlist, string, optional

    If \(\mathrm{section} = \mathrm{"pore"}\) the pore section is fitted. If \(\mathrm{section} = \mathrm{"reservoir"}\) the left reservoir area is fitted. If \(\mathrm{section} = \mathrm{[a,b]}\) the box area between a and b is fitted.

    infty_profilebool, optional

    Set to false to display all individual diffusion profiles for the selected lag times

    is_plotbool, optional

    Show diffusion profile

    is_errorbool, optional

    Show error area

    kwargs: dict, optional

    Dictionary with plotting parameters

    Returns:
    diff_profile_fitlist

    Diffusion profile \(\left(10^{-9} \frac{m^2}{s}\right)\) for an infinite lag time

    diff_profilesdict

    Diffusion profiles \(\left(10^{-9} \frac{m^2}{s}\right)\) for every calculated lag time

    binslist

    bins over the box length

    Back to top

    © Copyright 2021, Hamzeh Kraus.
    Created using Sphinx 7.4.6.