docs/build/html/searchindex.js

-Search.setIndex({"alltitles": {"": [[1, null]], "Abstract": [[1, "abstract"]], "Alternative installation": [[1, "alternative-installation"]], "Contact": [[1, "contact"]], "Define mesh and solver settings": [[0, "define-mesh-and-solver-settings"]], "Define parameters and boundary conditions": [[0, "define-parameters-and-boundary-conditions"]], "Example": [[0, null]], "Import FEniCSx implementation and necessary libraries": [[0, "import-fenicsx-implementation-and-necessary-libraries"]], "Installation": [[1, "installation"]], "Reproducibility Repository for: Numerical Treatment of a Thermodynamically Consistent Electrolyte Model documentation": [[1, null]], "Solve the system": [[0, "solve-the-system"]], "Source Code": [[2, null]], "The atomic fractions": [[0, "the-atomic-fractions"]], "The electric potential": [[0, "the-electric-potential"]], "The pressure": [[0, "the-pressure"]], "Thesis": [[1, "thesis"]], "Usage": [[1, "usage"]], "Visualize the results": [[0, "visualize-the-results"]]}, "docnames": ["example", "index", "src"], "envversion": {"sphinx": 62, "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": ["example.rst", "index.rst", "src.rst"], "indexentries": {}, "objects": {"": [[2, 1, 0, "-", "Helper_DoubleLayerCapacity"]], "ElectrolyticDiode": [[2, 0, 1, "", "ElectrolyticDiode"]], "Eq02": [[2, 0, 1, "", "solve_System_2eq"]], "Eq04": [[2, 0, 1, "", "create_refined_mesh"], [2, 0, 1, "", "solve_System_4eq"]], "EqN": [[2, 0, 1, "", "solve_System_Neq"]], "Helper_DoubleLayerCapacity": [[2, 0, 1, "", "C_dl"], [2, 0, 1, "", "Phi_pot_center"], [2, 0, 1, "", "Q_DL_dim_ana"], [2, 0, 1, "", "Q_DL_dimless_ana"], [2, 0, 1, "", "Q_num_"], [2, 0, 1, "", "Q_num_dim"], [2, 0, 1, "", "dx"], [2, 0, 1, "", "n"]]}, "objnames": {"0": ["py", "function", "Python function"], "1": ["py", "module", "Python module"]}, "objtypes": {"0": "py:function", "1": "py:module"}, "terms": {"0": [0, 1, 2], "05": 0, "08": 2, "1": [0, 1, 2], "10": [1, 2], "1024": 0, "12": 1, "14": 1, "1_000": 0, "1e": [0, 2], "2": [1, 2], "2024": 2, "26": 1, "3": [0, 1, 2], "4": [0, 1], "43": 1, "500": 2, "5412e": 0, "553e": 0, "6": 0, "7": 0, "8": [0, 1, 2], "A": [1, 2], "As": 1, "If": 2, "In": [0, 1], "Not": 2, "One": 2, "The": 1, "__file__": 0, "_\u03b1": 2, "_\u03c9": 2, "a2": [0, 2], "aachen": [1, 2], "abspath": 0, "access": 1, "accord": 1, "acom": 1, "activ": 1, "add": 1, "addit": 1, "all": 1, "alpha": 0, "also": 2, "an": [1, 2], "analyt": 2, "analyz": 1, "ani": [1, 2], "anion": [1, 2], "appli": 1, "ar": [0, 1, 2], "arrai": 2, "aspect": 1, "assum": 2, "atom": 2, "author": 1, "automat": 2, "avail": 1, "a\u00b2": 2, "a\u00b2k": 2, "a\u00b2p": 2, "b": 2, "bachelor": 1, "backwardbia": 2, "bath": 2, "batteri": 1, "behavior": 1, "best": 1, "beta": 1, "better": 1, "between": 2, "bia": 2, "bias_typ": 2, "boltzmann": 2, "bool": 2, "both": 2, "boundari": [1, 2], "bulk": 2, "c": [1, 2], "c_alpha": 2, "c_dl": 2, "calcul": [1, 2], "can": 1, "capac": [1, 2], "cation": [1, 2], "cell": 2, "center": 2, "charg": 2, "classic": [1, 2], "cm\u00b3": 2, "code": [0, 1], "combin": 1, "compar": 1, "compress": [1, 2], "comput": 1, "concentr": [1, 2], "conda": 1, "condit": [1, 2], "consid": 1, "consider": 1, "consist": [0, 2], "constant": 2, "contain": 1, "correct": 1, "creat": [1, 2], "create_refined_mesh": 2, "crucial": 1, "d_alpha": 2, "d_\u03b1": 2, "data": 1, "de": [1, 2], "default": 2, "del": 0, "densiti": 2, "depend": 1, "determin": 2, "dielectr": 2, "differ": [1, 2], "diffus": 2, "dimens": 2, "dimensio": 2, "dimension": [1, 2], "dimensionless": [1, 2], "diod": [1, 2], "direct": 2, "dirnam": 0, "discret": 2, "discuss": 1, "div": 2, "diverg": 2, "doi": 1, "dolfinx": [1, 2], "domain": 2, "done": 0, "doubl": [1, 2], "dr": 1, "dreyer": 2, "dx": 2, "d\u03c9": 2, "e0": 2, "electr": [1, 2], "electrolyt": [0, 2], "electrolyticdiod": 2, "element": [1, 2], "els": 2, "enabl": 1, "energi": 1, "env": 1, "environ": 1, "eq02": 2, "eq04": [0, 2], "eqn": 2, "equal": 2, "equat": 2, "equilibrium": 1, "essenti": 1, "everyth": 1, "exampl": [1, 2], "execut": [0, 1], "exp": 2, "expens": 1, "extend": 2, "extern": 1, "extra": 1, "e\u209a": 2, "f": [1, 2], "factor": 1, "fail": 1, "fals": 2, "fem": 2, "fenic": 1, "fenicsx": [1, 2], "figur": [0, 1], "file": [0, 1], "find": 1, "finit": 1, "first": [1, 2], "float": 2, "flux": 2, "folder": [0, 1], "forg": 1, "format": 1, "formul": 2, "forwardbia": 2, "fraction": 2, "free": 2, "from": [0, 1], "function": 2, "furthermor": 1, "futur": 1, "g_phi": 2, "gener": 1, "go": 0, "green": 1, "greener": 1, "grid": 0, "guhlk": 2, "ha": 1, "habscheid": [1, 2], "hard_hard_log": 2, "hard_log": [0, 2], "helper_doublelayercapac": 2, "how": 2, "i": [0, 1, 2], "ideal": 1, "implement": [1, 2], "improv": 1, "incompress": [0, 1, 2], "index": 2, "influenc": 1, "input": 2, "insert": [0, 1], "instead": 1, "int": 2, "investig": 1, "ion": 1, "isotherm": 1, "iter": 2, "j_a": 2, "j_c": 2, "j_\u03b1": 2, "jan": [1, 2], "join": 0, "just": 1, "k": [0, 2], "label": 0, "lambda2": [0, 2], "lambert": 1, "later": 2, "layer": [1, 2], "left": 2, "legend": 0, "length": 2, "librari": 1, "lifetim": 1, "limit": 1, "link": 1, "linux": 1, "list": 2, "ln": 2, "load": 1, "locat": 0, "log": [0, 2], "loss": 1, "lr": 2, "lx": 2, "ly": 2, "l\u00b2": 2, "l\u00b2n": 2, "m": 2, "machin": 1, "maco": 1, "mai": 2, "mainli": 1, "make": 1, "mani": 1, "manuel": 1, "materi": 1, "mathemat": 1, "matplotlib": [0, 1], "max_it": [0, 2], "maximum": 2, "mesh": 2, "method": 2, "mixtur": [1, 2], "model": [0, 2], "modulu": 2, "mpich": 1, "msh": 2, "mt": 1, "must": 1, "m\u00fcller": 2, "n": 2, "name": 1, "ndarrai": 2, "necessari": 1, "nernst": [1, 2], "neumann": 2, "neutral": 2, "newton": 2, "nobia": 2, "none": 2, "np": [0, 1, 2], "npz": 1, "nr_m": 2, "number": 2, "number_cel": [0, 2], "numer": 2, "numpi": [0, 1, 2], "o": 0, "offer": 1, "one": [1, 2], "onli": 2, "open": 1, "optim": 1, "option": 2, "p": [0, 2], "p_r": 2, "p_right": [0, 2], "p_vector": 2, "packag": 1, "paramet": [1, 2], "path": 0, "perform": 1, "phi": [0, 2], "phi_bia": 2, "phi_l": 2, "phi_left": [0, 2], "phi_pot": 2, "phi_pot_cent": 2, "phi_r": 2, "phi_right": [0, 2], "phi_vector": 2, "plai": 1, "planck": [1, 2], "plot": 0, "plt": 0, "poisson": 2, "poissonboltzmann": 2, "potenti": [1, 2], "predict": 1, "prepar": 1, "present": [1, 2], "pressur": [1, 2], "product": 1, "prof": 1, "purpos": 1, "py": 0, "pyplot": 0, "python": 1, "pyvista": 1, "q": 2, "q_dl": 2, "q_dl_dim_ana": 2, "q_dl_dimless_ana": 2, "q_num_": 2, "q_num_dim": 2, "read": 1, "readi": 2, "recommend": 1, "reduc": 2, "refer": 2, "refin": 2, "refinement_styl": [0, 2], "region": 2, "rel": 2, "relax": 2, "relax_param": [0, 2], "reproducablecod": [0, 1], "research": 1, "result": 1, "return": 2, "return_typ": [0, 2], "right": 2, "role": 1, "rtol": [0, 2], "rwth": [1, 2], "same": 0, "sc": 2, "scalar": 2, "scipi": 1, "sgn": 2, "should": [1, 2], "show": 0, "simplifi": [1, 2], "simul": 1, "softwar": 1, "solut": 2, "solv": 2, "solvat": [1, 2], "solve_system_2eq": 2, "solve_system_4eq": [0, 2], "solve_system_neq": 2, "solver": [1, 2], "some": 1, "sourc": 1, "space": 2, "spatial": 2, "speci": 2, "specifi": 2, "src": [0, 1], "src_path": 0, "store": 1, "str": 2, "subfold": 1, "supervisor": 1, "support": 1, "svg": 1, "sy": 0, "system": [1, 2], "ternari": 0, "ternaryelectrolyt": 0, "test": 1, "theisen": 1, "theissen": 1, "them": 1, "thermodynam": [0, 2], "thesi": 2, "thi": [0, 1], "those": 1, "time": 1, "todo": 1, "toler": 2, "torrilhon": 1, "total": 2, "toward": 2, "transit": 1, "transport": 1, "treatment": 2, "triangl": 2, "true": 2, "try": 2, "two": 2, "type": 2, "u": 2, "under": 1, "understand": 1, "uniform": 2, "unit": [1, 2], "univers": 1, "us": [1, 2], "v": 2, "valu": 2, "varphi": 0, "vector": [0, 2], "version": [1, 2], "via": 1, "visual": 1, "wa": 1, "we": 0, "well": 1, "were": 1, "which": 1, "window": 1, "without": 1, "work": [0, 1], "written": 1, "wsl2": 1, "x": [0, 2], "x0": [0, 2], "x1": [0, 2], "x_vector": 2, "xlabel": 0, "xlim": 0, "x\u2099": 2, "y": [1, 2], "y_": 0, "y_a": [0, 2], "y_a_bath": 2, "y_a_r": [0, 2], "y_a_vector": 2, "y_alpha": 2, "y_c": [0, 2], "y_c_bath": 2, "y_c_r": [0, 2], "y_c_vector": 2, "y_n_r": 2, "y_r": 2, "yet": 2, "ylabel": 0, "yml": 1, "you": 2, "z_a": [0, 2], "z_alpha": 2, "z_c": [0, 2], "z_\u03b1": 2, "zero": 2, "\u00b5a": 2, "\u03b1": 2, "\u03b3": 2, "\u03ba": 2, "\u03bb": 2, "\u03bb\u00b2": 2, "\u03bb\u00b2\u03b4": 2, "\u03bb\u1d38": 2, "\u03bb\u1d3f": 2, "\u03c6": 2, "\u03c6\u1d38": 2, "\u03c6\u1d3f": 2, "\u2081": 2}, "titles": ["Example", "Reproducibility Repository for: Numerical Treatment of a Thermodynamically Consistent Electrolyte Model documentation", "Source Code"], "titleterms": {"The": 0, "abstract": 1, "altern": 1, "atom": 0, "boundari": 0, "code": 2, "condit": 0, "consist": 1, "contact": 1, "defin": 0, "document": 1, "electr": 0, "electrolyt": 1, "exampl": 0, "fenicsx": 0, "fraction": 0, "implement": 0, "import": 0, "instal": 1, "librari": 0, "mesh": 0, "model": 1, "necessari": 0, "numer": 1, "paramet": 0, "potenti": 0, "pressur": 0, "repositori": 1, "reproduc": 1, "result": 0, "set": 0, "solv": 0, "solver": 0, "sourc": 2, "system": 0, "thermodynam": 1, "thesi": 1, "treatment": 1, "usag": 1, "visual": 0}})
\ No newline at end of file

docs/source/src/Miscellaneous.rst

+Miscellaneous
+=============
+
+.. autofunction:: RefinedMesh1D.create_refined_mesh
+    
+.. automodule:: Helper_DoubleLayerCapacity
+    :members:
+    :undoc-members:
+    :show-inheritance:
\ No newline at end of file