searchindex.js

Search.setIndex({"alltitles": {"About pymm": [[0, null]], "Configuration file": [[2, null]], "Contribute to the software": [[3, "contribute-to-the-software"]], "Contributing": [[3, null]], "Description": [[9, "description"]], "Device": [[4, null], [5, "device"]], "Examples": [[5, null]], "Figure- and device-related parameters": [[2, "figure-and-device-related-parameters"]], "Gmsh": [[8, "gmsh"]], "Ground Rules": [[3, "ground-rules"]], "Image": [[5, "image"], [6, null]], "Image-related parameters": [[2, "image-related-parameters"]], "Indices and tables": [[7, "indices-and-tables"]], "Installation": [[8, null]], "Introduction": [[9, null]], "Mesh-related parameters": [[2, "mesh-related-parameters"]], "Module contents": [[13, "module-pymm"], [14, "module-pymm.core"]], "Online": [[5, "online"], [11, null]], "OpenFOAM": [[8, "openfoam"]], "Output folder": [[12, null]], "Overview": [[9, "overview"]], "Python package": [[8, "python-package"]], "Related": [[16, null]], "Remaining parameters": [[2, "remaining-parameters"]], "Reporting issues or problems": [[3, "reporting-issues-or-problems"]], "Seek support": [[3, "seek-support"]], "Submodules": [[14, "submodules"]], "Subpackages": [[13, "subpackages"]], "Welcome to pymm\u2019s documentation!": [[7, null]], "ad-micp": [[16, "ad-micp"]], "expreccs": [[16, "expreccs"]], "plopm": [[16, "plopm"]], "pycopm": [[16, "pycopm"]], "pymm": [[1, "pymm"], [10, null]], "pymm Python API": [[1, null]], "pymm package": [[13, null]], "pymm.core package": [[14, null]], "pymm.core.pymm module": [[15, null]], "pyopmnearwell": [[16, "pyopmnearwell"]], "pyopmspe11": [[16, "pyopmspe11"]]}, "docnames": ["about", "api", "configuration_file", "contributing", "device", "examples", "image", "index", "installation", "introduction", "modules", "online", "output_folder", "pymm", "pymm.core", "pymm.core.pymm", "related"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["about.rst", "api.rst", "configuration_file.rst", "contributing.rst", "device.rst", "examples.rst", "image.rst", "index.rst", "installation.rst", "introduction.rst", "modules.rst", "online.rst", "output_folder.rst", "pymm.rst", "pymm.core.rst", "pymm.core.pymm.rst", "related.rst"], "indexentries": {}, "objects": {"": [[13, 0, 0, "-", "pymm"]], "pymm": [[14, 0, 0, "-", "core"]], "pymm.core": [[15, 0, 0, "-", "pymm"]], "pymm.core.pymm": [[15, 1, 1, "", "boundary_tags_left_bottom"], [15, 1, 1, "", "boundary_tags_right_top"], [15, 1, 1, "", "extract_borders"], [15, 1, 1, "", "identify_cells"], [15, 1, 1, "", "main"], [15, 1, 1, "", "make_figures"], [15, 1, 1, "", "pad_with"], [15, 1, 1, "", "process_image"], [15, 1, 1, "", "pymm"], [15, 1, 1, "", "run_stokes"], [15, 1, 1, "", "run_tracer"], [15, 1, 1, "", "write_geo"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:function"}, "terms": {"": [2, 5, 11], "0": [2, 5, 11], "03e": 2, "0e": [2, 5, 11], "1": [2, 5, 11], "10": [3, 8], "100": 2, "10000": [2, 5, 11], "101070": 0, "1068x1068": [5, 11], "12": [2, 5, 8, 11], "120": [2, 5, 11], "15": [5, 11], "160": [], "1c": 2, "1e": [2, 5, 11], "2": [2, 5, 11], "20": [5, 6], "2009": [5, 11], "24": 3, "2a": [5, 11], "2d": 2, "2e": 2, "3": [2, 5, 11], "331841": 0, "35": [4, 5], "3d": 2, "4": 2, "5": [2, 5, 11], "50": [5, 11], "500": 2, "52": 2, "5e": 2, "6": [2, 5, 11], "600e": [5, 11], "6e": [5, 11], "7": [2, 5, 11], "74e": 2, "8": [2, 5, 11], "805x252": 2, "8e": [2, 5, 11], "A": 16, "As": 0, "For": [0, 2, 8], "If": 8, "In": [3, 5, 6, 11], "NO": [5, 11], "On": 2, "The": [0, 1, 2, 3, 4, 5, 6, 8, 9, 11, 12], "Then": [2, 4, 5, 11, 12], "There": 2, "To": 8, "_build": 3, "_iaxi": 15, "about": [2, 3, 7], "accept": 3, "action": 3, "activ": 8, "ad": [5, 7, 11, 15], "add": [4, 5, 6, 11, 15], "addit": 12, "after": 12, "al": [5, 11], "all": [3, 4, 5, 6, 8, 9, 11], "allow": 2, "also": 3, "altern": 3, "alwai": 2, "an": [0, 3], "anaconda": 8, "analys": 3, "ani": 3, "anoth": 2, "answer": 3, "api": 7, "appli": 9, "applic": 2, "approach": [0, 3], "approxim": [2, 5, 11], "approximate_polygon": 2, "apt": 8, "ar": [0, 2, 3, 4, 5, 6, 8, 9, 11, 12, 16], "arg": 15, "argument": 9, "assum": [5, 6], "avail": [5, 6, 8, 11], "base": [0, 9], "bc": [2, 5, 11], "been": [2, 5, 11], "befor": 3, "below": [2, 16], "benali2019": 2, "benchmark": 16, "between": 2, "bin": 8, "binari": [2, 5, 11], "black": [2, 3, 5, 11], "border": [2, 5, 11, 15], "bordertol": [2, 5, 11], "bottom": [2, 4, 5, 6, 11, 15], "boundari": [5, 9, 11, 15], "boundary_tags_left_bottom": [13, 14, 15], "boundary_tags_right_top": [13, 14, 15], "build": [3, 5, 11], "built": [5, 11], "ca": [4, 5, 6, 11], "calcit": 16, "call": 12, "can": [2, 3, 8], "case": [2, 5, 11], "cd": 8, "cell": 15, "center": 0, "centr": 0, "chang": [3, 12], "channel": [2, 5, 11], "channelwidth": [2, 5, 11], "check": 16, "checker": 3, "checkout": 8, "ci": [3, 8], "clone": 8, "cluster": [2, 5, 11], "co2": 16, "coarsen": 16, "code": [3, 8, 13], "coeffici": [2, 5, 11], "collabor": 3, "color": [2, 5, 11], "com": [8, 9], "command": [5, 6, 8, 11], "commit": 3, "comput": [0, 2], "concentr": [4, 5, 6, 11], "condit": [2, 5, 11], "configur": [4, 5, 6, 7, 9, 11], "consid": [2, 4, 5, 6, 9, 11], "consist": 2, "contain": [1, 5, 11], "content": [1, 3, 7, 10], "contour": [2, 5, 11, 15], "contribut": [0, 7, 8], "control": 2, "converg": [2, 5, 11], "convert": [2, 5, 11], "copi": 3, "core": [1, 10, 13], "corner": [4, 5], "correspond": [2, 4, 5, 6], "could": [2, 9, 12], "cov": 3, "creat": [2, 3, 8], "criteria": [2, 5, 11], "criterium": [2, 5, 11], "cross": 2, "csp": 16, "cssr": [8, 9], "current": [2, 9, 12], "dark": [2, 5, 11], "data": 15, "de": 2, "decreas": 2, "default": [5, 6, 9], "defin": 2, "depend": 8, "depth": [2, 5, 11], "describ": [3, 5, 6, 9], "descript": 7, "detail": 2, "dev": [3, 8], "develop": 8, "devic": [7, 9, 11], "dic": 15, "dict": 15, "dictionari": 15, "differ": 2, "diffus": [2, 5, 11], "dimens": 2, "directli": 12, "dmar": [5, 11], "doc": [3, 15], "document": [3, 9, 12], "domain": 9, "dynam": [0, 2, 5, 11, 16], "e": [2, 5, 8, 9, 11, 12], "easili": 9, "edg": 8, "element": 2, "email": 3, "end": [2, 5, 11], "enough": [5, 6], "entri": [2, 5, 6], "environ": 8, "et": [5, 11], "etc": 2, "exampl": [2, 4, 6, 7, 11], "exectu": [5, 11], "execut": [1, 2, 3, 4, 5, 6, 8, 9, 11, 12], "exprecc": 7, "extend": [2, 3, 9], "extra": 15, "extract": [2, 5, 11, 15], "extract_bord": [13, 14, 15], "factor": [2, 5, 11], "familiar": 3, "featur": 0, "field": 9, "fig": [2, 5, 11], "figur": [5, 7, 9, 11, 15], "file": [1, 3, 4, 5, 6, 7, 9, 11, 12, 15], "filter": 2, "first": 2, "fix": 3, "flag": [4, 5, 11], "flexibl": 16, "flow": [4, 5, 6, 9, 11, 15, 16], "flow_trac": 9, "fluid": [0, 2, 5, 11], "fluid_dens": [2, 5, 11], "folder": [1, 3, 5, 6, 7, 8, 9], "follow": [2, 4, 5, 6, 8, 9, 11, 12], "fork": [0, 3], "format": 3, "found": 2, "framework": [5, 6, 9, 16], "from": [2, 3, 4, 5, 8, 9, 11, 16], "full": 9, "function": 15, "fund": 0, "further": 9, "g": [2, 5, 8, 9, 11, 12], "gave": [5, 11], "gener": [2, 3, 9, 12, 15, 16], "geo": 15, "geolog": 16, "geometri": [2, 9], "get": [3, 8], "gif": 16, "git": 8, "github": [3, 5, 6, 8, 9, 11], "global": 15, "gmsh": [5, 6, 7, 9, 11, 15], "grai": 2, "grain": [2, 5, 9, 11, 15], "grainmean": [2, 5, 11], "grainssiz": [2, 5, 11], "grainstol": [2, 5, 11], "greater": 2, "grid": 2, "ground": 7, "ha": 2, "have": [2, 5, 11], "height": [2, 5, 11], "help": 3, "here": [2, 4, 5, 11, 12], "higher": 2, "home": [5, 11], "host": 9, "howev": 2, "html": [3, 15], "http": [8, 9, 15], "i": [0, 1, 2, 3, 4, 5, 6, 8, 9, 11, 12], "identifi": 15, "identify_cel": [13, 14, 15], "ignor": 3, "imag": [0, 4, 7, 9, 11, 15], "implement": [2, 9], "import": 3, "in_imag": 15, "includ": [2, 12], "increas": 2, "index": 7, "induc": 16, "inject": 2, "inlet": [2, 5, 11], "inletloc": [2, 5, 11], "inletvalu": [2, 5, 11], "input": [2, 5, 11, 15], "insid": 8, "instal": [3, 7], "interest": [4, 5, 8, 11, 16], "intern": 2, "interv": [2, 5, 11], "introduct": 7, "issu": [0, 7], "iter": [2, 5, 11], "iterationsmax": [2, 5, 11], "joekar": [5, 11], "keep": 9, "kg": [2, 5, 11], "kinemat": [2, 5, 11], "kwarg": 15, "l": 8, "later": 15, "leakag": 16, "left": [2, 4, 5, 11, 15], "lenght": [2, 5, 11], "length": [2, 5, 11], "let": 2, "light": [2, 5, 11], "line": [2, 3, 5, 6, 11], "linewidth": [2, 5, 11], "link": 2, "lint": 8, "linux": 8, "liu2022": 2, "local": 3, "locat": [1, 2, 5, 11, 15], "look": [2, 3], "m": [2, 4, 5, 8, 9, 11], "m2": [2, 5, 11], "m3": [2, 5, 11], "main": [1, 3, 13, 14, 15], "maintain": 3, "make": [3, 15], "make_figur": [13, 14, 15], "mako": [1, 2], "mamba": 8, "manag": 8, "mantain": 3, "mathemat": 2, "maximum": [2, 5, 11], "mean": 2, "measur": 2, "merg": 3, "mesh": [5, 6, 7, 9, 11], "mesh_flow": 9, "meshsiz": [2, 5, 11], "micp": 7, "microbi": 16, "micromodel": [2, 5, 6, 11], "microsystem": [2, 5, 6, 9, 11, 15], "middl": [2, 4, 5, 6, 11], "might": [3, 8, 16], "miniforg": 8, "minimum": [2, 5, 11], "minut": [4, 5, 6, 11], "miss": 3, "mode": [2, 9], "model": [2, 16], "modifi": [2, 8, 12], "modul": [1, 7, 10, 16], "more": [0, 2, 3], "much": 2, "mypi": 3, "name": [5, 6, 9, 11, 15], "navier": 15, "need": 3, "new": [0, 2, 3, 15], "next": 2, "niasar": [5, 11], "nice": [2, 3], "norc": 0, "norceresearch": [5, 11], "norwegian": 0, "now": [4, 5], "number": [0, 2, 5, 11], "numer": [2, 5, 9, 11, 12], "numpi": 15, "o": 9, "one": [2, 5, 6, 12], "onli": [2, 9], "onlin": [2, 7], "openfoam": [2, 7, 9, 12, 15], "opm": 16, "option": 9, "org": 15, "our": 3, "out": 16, "output": [2, 7, 9], "overview": 7, "own": 3, "p": [5, 9, 11], "pa": [2, 5, 11], "packag": [0, 1, 7, 9, 10], "pad": 15, "pad_width": 15, "pad_with": [13, 14, 15], "page": [3, 5, 6, 7, 8], "paramet": [5, 6, 7, 9, 11, 12, 15], "paraview": 12, "path": [5, 9, 11], "pattern": 2, "perform": 9, "pip": [3, 8], "pixel": [2, 5, 11], "pleas": [0, 3], "plopm": 7, "png": [5, 6, 9, 11, 16], "point": 2, "polygon": [2, 5, 11], "pore": 2, "porespi": [2, 9], "possibl": 3, "pr": 3, "precipit": 16, "prefer": 3, "present": 2, "pressur": [2, 4, 5, 6, 11], "pressureconv": [2, 5, 11], "previou": 3, "problem": 7, "process": 15, "process_imag": [13, 14, 15], "produc": [2, 5, 11], "project": [0, 16], "pull": [0, 3], "push": 3, "pushd": 3, "pycopm": 7, "pylint": 3, "pymm": [2, 3, 4, 5, 6, 8, 9, 11, 12], "pyopmnearwel": 7, "pyopmspe11": 7, "pytest": 3, "python": [0, 7, 9, 15, 16], "python3": 8, "quad": 2, "quick": 16, "r": [3, 8], "rais": [0, 3], "reach": [2, 5, 11], "real": 2, "reduc": 2, "refer": [2, 15], "region": 16, "relat": [5, 7, 11, 12], "reli": 9, "remain": 7, "remark": 2, "remedi": 16, "replac": 3, "repo": [3, 8], "report": 7, "repositori": [3, 8], "request": [0, 3], "requir": [3, 8, 15], "rescal": [2, 5, 11], "research": 0, "reservoir": 16, "resolut": 2, "resourc": [0, 2], "respect": 2, "result": [2, 4, 5, 6, 11, 12], "return": 15, "review": 3, "right": [2, 4, 5, 11, 15], "rise": 3, "rule": 7, "run": [2, 3, 5, 6, 9, 12, 15], "run_stok": [13, 14, 15], "run_trac": [13, 14, 15], "same": [4, 5], "save": [5, 6, 11, 12], "scalartransportfoam": 2, "scale": 2, "scheme": [2, 5, 11, 12], "screenshot": [4, 5, 6, 11, 12], "script": [1, 3, 8, 15], "search": 7, "section": [5, 6], "see": [2, 3, 8, 12, 15], "seek": 7, "segment": 9, "select": 12, "send": 3, "set": [2, 5, 11], "setup": [4, 5, 6], "setuptool": 8, "shape": 2, "show": [2, 5, 11, 12], "side": 2, "simpl": 9, "simplefoam": 2, "simplifi": 16, "simul": [2, 4, 5, 6, 8, 9, 11, 12, 15, 16], "sinc": [5, 6, 11], "singl": 3, "site": 16, "six": 3, "size": [2, 5, 11], "skimag": [2, 9], "skip": 8, "slip": 2, "smaller": 2, "softwar": 7, "solut": [2, 5, 11], "solver": [2, 5, 9, 11, 12], "some": 16, "soon": 3, "sourc": [5, 8, 11], "space": 2, "spatial": 9, "spe11": 16, "specif": 8, "squash": 3, "src": 3, "stabl": 15, "static": 3, "step": [2, 3, 5, 8, 11], "stoke": [2, 5, 11, 15], "storag": 16, "str": 15, "studi": 16, "submodul": [1, 10, 13], "subpackag": [1, 7, 10], "subsect": 2, "subsurfac": 0, "succe": 3, "support": [7, 9], "sustain": 0, "t": [4, 5, 6, 9, 11], "tag": [8, 15], "templat": [1, 2], "term": 3, "termin": [5, 6, 9, 11], "test": [3, 8], "text": [5, 11], "than": [0, 2, 3], "them": 16, "thi": [0, 2, 3, 5, 6, 8, 9, 11], "those": 2, "three": 2, "threshold": [2, 5, 11], "tick": [2, 5, 11], "time": [2, 4, 5, 6, 11], "toler": [2, 5, 11, 12], "toml": [5, 6, 9, 11, 12], "tool": [8, 9, 16], "top": [2, 4, 5, 6, 11, 15], "tracer": [2, 4, 5, 6, 9, 11, 15], "tracerstep": [2, 5, 11], "tracertim": [2, 5, 11], "tracerwrit": [2, 5, 11], "transform": 2, "trim_small_clust": 2, "try": 3, "tutori": 3, "two": 2, "txt": [3, 8], "type": [2, 8, 9, 16], "u": 2, "ubuntu": [3, 8], "upgrad": 8, "us": [0, 2, 3, 5, 8, 9, 11, 12, 16], "user": 3, "v2024": 8, "valid": 2, "valu": 2, "vector": 15, "veloc": [2, 4, 5, 6, 9, 11], "velocityconv": [2, 5, 11], "venv": 8, "version": [5, 8, 11, 13], "vertic": 2, "via": [2, 5, 8, 11], "virtual": 8, "viscoc": [2, 5, 11], "viscos": [2, 5, 11], "visit": 3, "visual": 12, "void": 9, "vpymm": 8, "vtk": 16, "vtk_flowstok": 12, "vtk_tracertransport": 12, "wa": [4, 5, 6, 11], "wall": [2, 15], "water": 9, "we": [2, 3, 4, 5, 6, 11], "welcom": [0, 3], "well": [3, 16], "wheel": 8, "where": [2, 8, 9], "which": 2, "while": [2, 8], "white": [2, 5, 11], "whole": [5, 6, 9], "width": [2, 5, 11], "work": [3, 8], "write": [2, 5, 8, 11, 15], "write_geo": [13, 14, 15], "x": 2, "yml": [3, 8], "you": [3, 8], "your": 3}, "titles": ["About pymm", "pymm Python API", "Configuration file", "Contributing", "Device", "Examples", "Image", "Welcome to pymm\u2019s documentation!", "Installation", "Introduction", "pymm", "Online", "Output folder", "pymm package", "pymm.core package", "pymm.core.pymm module", "Related"], "titleterms": {"": 7, "about": 0, "ad": 16, "api": 1, "configur": 2, "content": [13, 14], "contribut": 3, "core": [14, 15], "descript": 9, "devic": [2, 4, 5], "document": 7, "exampl": 5, "exprecc": 16, "figur": 2, "file": 2, "folder": 12, "gmsh": 8, "ground": 3, "imag": [2, 5, 6], "indic": 7, "instal": 8, "introduct": 9, "issu": 3, "mesh": 2, "micp": 16, "modul": [13, 14, 15], "onlin": [5, 11], "openfoam": 8, "output": 12, "overview": 9, "packag": [8, 13, 14], "paramet": 2, "plopm": 16, "problem": 3, "pycopm": 16, "pymm": [0, 1, 7, 10, 13, 14, 15], "pyopmnearwel": 16, "pyopmspe11": 16, "python": [1, 8], "relat": [2, 16], "remain": 2, "report": 3, "rule": 3, "seek": 3, "softwar": 3, "submodul": 14, "subpackag": 13, "support": 3, "tabl": 7, "welcom": 7}})