From 1030135201c7c9feb732c8dbf66d01a3969f9e08 Mon Sep 17 00:00:00 2001 From: Ishaan Desai Date: Thu, 10 Oct 2024 15:06:37 +0200 Subject: [PATCH] Add practical bound recommendations for the coarsening and refining constants --- docs/configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 2a8c965..aedbed1 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -116,8 +116,8 @@ Parameter | Description `type` | Set to either `local` or `global`. The type of adaptivity matters when the Micro Manager is run in parallel. `local` means comparing micro simulations within a local partitioned domain for similarity. `global` means comparing micro simulations from all partitions, so over the entire domain. `data` | List of names of data which are to be used to calculate if micro-simulations are similar or not. For example `["temperature", "porosity"]`. `history_param` | History parameter $$ \Lambda $$, set as $$ \Lambda >= 0 $$. -`coarsening_constant` | Coarsening constant $$ C_c $$, set as $$ C_c < 1 $$. -`refining_constant` | Refining constant $$ C_r $$, set as $$ C_r >= 0 $$. +`coarsening_constant` | Coarsening constant $$ C_c $$, set as $$ 0 =< C_c < 1 $$. +`refining_constant` | Refining constant $$ C_r $$, set as $$ 0 =< C_r < 1 $$. `every_implicit_iteration` | If True, adaptivity is calculated in every implicit iteration.
If False, adaptivity is calculated once at the start of the time window and then reused in every implicit time iteration. `similarity_measure`| Similarity measure to be used for adaptivity. Can be either `L1`, `L2`, `L1rel` or `L2rel`. By default, `L1` is used. The `rel` variants calculate the respective relative norms. This parameter is *optional*.