From c27642208bb99cfff0da4687f8780d399cd87c19 Mon Sep 17 00:00:00 2001 From: shac170 Date: Fri, 26 Apr 2024 13:17:46 -0700 Subject: [PATCH] Added documentation for dd and reorganized other docs --- docs/source/pythonapi/index.rst | 28 ++++++++++++++-------------- mcdc/input_.py | 26 +++++++++++++++++++++----- 2 files changed, 35 insertions(+), 19 deletions(-) diff --git a/docs/source/pythonapi/index.rst b/docs/source/pythonapi/index.rst index 31a5e32f..3e532e0c 100644 --- a/docs/source/pythonapi/index.rst +++ b/docs/source/pythonapi/index.rst @@ -27,12 +27,10 @@ Defining geometry :nosignatures: :template: omcfunction.rst - mcdc.surface mcdc.cell - mcdc.universe mcdc.lattice - - + mcdc.surface + mcdc.universe Defining simulation ------------------- @@ -42,12 +40,10 @@ Defining simulation :nosignatures: :template: omcfunction.rst - mcdc.source - mcdc.tally mcdc.eigenmode mcdc.setting - - + mcdc.source + mcdc.tally Defining techniques ------------------- @@ -57,16 +53,20 @@ Defining techniques :nosignatures: :template: omcfunction.rst + mcdc.branchless_collision + mcdc.domain_decomposition + mcdc.dsm + mcdc.IC_generator + mcdc.iQMC mcdc.implicit_capture - mcdc.weighted_emission mcdc.population_control - mcdc.branchless_collision mcdc.time_census - mcdc.weight_window - mcdc.iQMC + mcdc.weighted_emission mcdc.weight_roulette - mcdc.IC_generator - mcdc.dsm + mcdc.weight_window + + + diff --git a/mcdc/input_.py b/mcdc/input_.py index 0531ba11..a5056643 100644 --- a/mcdc/input_.py +++ b/mcdc/input_.py @@ -1392,12 +1392,31 @@ def domain_decomposition( x=None, y=None, z=None, - t=None, exchange_rate=100, - bank_size=1e5, work_ratio=None, repro=True, ): + """ + Activate domain decomposition. + + Parameters + ---------- + x : array_like[float], optional + Location of subdomain boundaries in x (default None). + y : array_like[float], optional + Location of subdomain boundaries in y (default None). + z : array_like[float], optional + Location of subdomain boundaries in z (default None). + exchange_rate : float, optional + number of particles to acumulate in the domain banks before sending. + work_ratio : array_like[integer], optional + Inte + + Returns + ------- + A domain decomposition card. + + """ card = mcdc.input_deck.technique card["domain_decomposition"] = True card["domain_bank_size"] = int(1e5) @@ -1414,9 +1433,6 @@ def domain_decomposition( if z is not None: card["dd_mesh"]["z"] = z dom_num += len(z) - if t is not None: - card["dd_mesh"]["t"] = t - dom_num += len(t) # Set work ratio if work_ratio is None: card["dd_work_ratio"] = None