Update wiki by vivi235711 · Pull Request #466 · gamer-project/gamer

vivi235711 · 2025-05-06T09:50:01Z

Partially resolve #400.
The remaining part has been completed by @hsinhaoHHuang.

Changes:

Added links, pages, and descriptions for the following parameters:

Particles

PAR_TR_VEL_CORR

Timesteps

DT__PHASE
DT__HYBRID_CFL
DT__HYBRID_CFL_INIT
DT__HYBRID_VELOCITY
DT__HYBRID_VELOCITY_INIT

Refinement

OPT__FLAG_ENGY_DENSITY
OPT__FLAG_INTERFERENCE
OPT__FLAG_SPECTRAL
OPT__FLAG_SPECTRAL_N

ELBDM (new page)

ELBDM_MASS
ELBDM_PLANCK_CONST
ELBDM_LAMBDA
ELBDM_TAYLOR3_COEFF
ELBDM_TAYLOR3_AUTO
ELBDM_REMOVE_MOTION_CM
ELBDM_BASE_SPECTRAL
ELBDM_MATCH_PHASE
ELBDM_FIRST_WAVE_LEVEL
OPT__RES_PHASE
SPEC_INT_TABLE_PATH
SPEC_INT_XY_INSTEAD_DEPHA
SPEC_INT_VORTEX_THRESHOLD
SPEC_INT_GHOST_BOUNDARY

MPI and OpenMP

OPT__OVERLAP_MPI
OPT__LB_EXCHANGE_FATHER

Hydro

MIN_TEMP
MIN_ENTR

Gravity

EXT_POT_TABLE_DH_X
EXT_POT_TABLE_DH_Y
EXT_POT_TABLE_DH_Z
EXT_POT_TABLE_FLOAT8
OPT__GRAVITY_EXTRA_MASS

Interpolation

OPT__INT_PHASE
New interpolation schemes: |8 | Spectral |

Updated item: PAR_TR_VEL_CORR, DT__PHASE, DT__HYBRID_CFL, DT__HYBRID_CFL_INIT, DT__HYBRID_VELOCITY, DT__HYBRID_VELOCITY_INIT, OPT__FLAG_ENGY_DENSITY, OPT__FLAG_INTERFERENCE, OPT__FLAG_SPECTRAL, OPT__FLAG_SPECTRAL_N, OPT__LB_EXCHANGE_FATHER, OPT__OVERLAP_MPI, MIN_TEMP, MIN_ENTR, EXT_POT_TABLE_DH_X, EXT_POT_TABLE_DH_Y, EXT_POT_TABLE_DH_Z, EXT_POT_TABLE_FLOAT8, OPT__GRAVITY_EXTRA_MASS, OPT__INT_PHASE.

Add new page for ELBDM runtime parameters Add spectral Interpolation

vivi235711 · 2025-05-08T05:09:30Z

@@ -81,6 +94,16 @@ set [[PAR_IMPROVE_ACC | Runtime Parameters:-Particles#PAR_IMPROVE_ACC]]=1.
 must be disabled. In addition, it is currently recommended to disable
 [[AUTO_REDUCE_DT | Runtime Parameters:-Timestep#AUTO_REDUCE_DT]].

+<a name="OPT__LB_EXCHANGE_FATHER"></a>


I'm not sure where to place this parameter. Currently I put here.

vivi235711 · 2025-05-08T05:09:53Z

I think it's ok not to mention --model=ELBDM here?

vivi235711 · 2025-05-08T05:11:24Z

+    * **Restriction:**
+
+OPT__GRAVITY_EXTRA_MASS
+<a name="OPT__GRAVITY_EXTRA_MASS"></a>


Here I didn't write a detailed guide of how to edit this function. Is that ok?

I think it might be better to make a brief tutorial such as:

Go to file src/SelfGravity/Poi_AddExtraMassForGravity.cpp.

Copy Poi_AddExtraMassForGravity_Template() and make your own function in your test problem.

Set up Poi_AddExtraMassForGravity_Ptr.

Asking the user to edit src/SelfGravity/Poi_AddExtraMassForGravity.cpp might be misleading.

Instead of writing the guide here I think it might be cleaner to make a new subsection under Adding-New-Simulations#vi-add-problem-specific-functionalities.

I think it would be better to put the tutorial on the page gravity to match the existing pattern "external acceleration/potential". But I still added a new subsection under Adding-New-Simulations#vi-add-problem-specific-functionalities and give a link to page gravity.

technic960183 · 2025-06-12T08:42:30Z

Hi @vivi235711,

I noticed that this PR is targeting the v2.2.x release branch instead of main. Just wanted to check, is this intentional, or was it meant to go into main? Thanks.

vivi235711 · 2025-06-12T09:54:10Z

@jzuhone Hi, I saw that you changed the base branch from main to v2.2.x. I believe this update should be be more appropriate for main branch, so I switched it back. Was there a specific reason for targeting v2.2.x instead?
@technic960183 Thanks for pointing this out!

jzuhone · 2025-06-12T12:03:03Z

@vivi235711 I am not sure how this happened; I didn't intend to do this and I didn't actually hit the buttons for it. I use GitHub on my phone so something accidental may have happened. Sorry about that.

HsunYeong · 2026-03-09T05:06:46Z

+    * **Restriction:**
+
+OPT__GRAVITY_EXTRA_MASS
+<a name="OPT__GRAVITY_EXTRA_MASS"></a>


I think it might be better to make a brief tutorial such as:

Go to file src/SelfGravity/Poi_AddExtraMassForGravity.cpp.

Copy Poi_AddExtraMassForGravity_Template() and make your own function in your test problem.

Set up Poi_AddExtraMassForGravity_Ptr.

Asking the user to edit src/SelfGravity/Poi_AddExtraMassForGravity.cpp might be misleading.

Instead of writing the guide here I think it might be cleaner to make a new subsection under Adding-New-Simulations#vi-add-problem-specific-functionalities.

HsunYeong · 2026-03-09T05:41:47Z

+Mass introduced here is only used for gravity (e.g., Poisson equation) and 
+is excluded from other equations (e.g., hydro/MHD/Schrödinger) and output data.
+To configure the extra mass, edit /src/SelfGravity/Poi_AddExtraMassForGravity.cpp.
+Refer to [[Initialization Function | Adding-New-Simulations#initialization-function]] for details.


I think it might be better to refer to #vi-add-problem-specific-functionalities section instead of #initialization-function? Or maybe add a new subsection below #external-potential. See my other comment.

hyschive · 2026-03-14T03:29:15Z

Add ELBDM_RESCALE_MASS_ERROR and ELBDM_RESCALE_MASS_STEPS once #496 is merged.

hyschive · 2026-03-25T06:46:34Z

Add ELBDM_RESCALE_MASS_ERROR and ELBDM_RESCALE_MASS_STEPS once #496 is merged.

#496 has been merged

hyschive · 2026-04-16T13:04:15Z

@vivi235711 When you have time, please update this PR to resolve the conflicts. Thanks!

If you don't have time to address @HsunYeong's comments at the moment, please feel free to let us know. Hsun-Yeong can follow up on them in a separate PR.

Add brief tutorial for OPT__GRAVITY_EXTRA_MASS Typo fix

Resolve conflicts Fix links

…235711/466

vivi235711 · 2026-04-21T09:19:03Z

@HsunYeong
Thanks for your review. I've updated the wiki accoding to your comments. Please take a look when you have time.
Main changes:

OPT__GRAVITY_EXTRA_MASS brief tutorial
Add ELBDM_RESCALE_MASS_ERROR and ELBDM_RESCALE_MASS_STEPS
Resolve the conflicts and fix the links.

hyschive · 2026-04-22T01:08:58Z

@vivi235711 I really appreciate you taking the time to update this PR!

@HsunYeong Please help review this PR again after you are back from your trip. Thanks!

HsunYeong

@vivi235711 Thank you for the update. I think the PR is ready once the typo is fixed.

HsunYeong · 2026-04-23T03:08:49Z

 is just to avoid redundant assignments to the same field index variable.

-    The second parameter should be set to either `FIXUP_FLUX_YES` or `FIXUP_FLUX_NO`.
+    Tfuld be set to either `FIXUP_FLUX_YES` or `FIXUP_FLUX_NO`.


Suggested change

Tfuld be set to either `FIXUP_FLUX_YES` or `FIXUP_FLUX_NO`.

The second parameter should be set to either `FIXUP_FLUX_YES` or `FIXUP_FLUX_NO`.

I think some words are accidentally removed here?

HsunYeong · 2026-04-23T03:21:28Z


 The workflow is triggered when changes are pushed to any of the following files:
 - `src/Init/Init_Load_Parameter.cpp`
 - `example/input/Input__Paramter`


There is a typo Paramter, which is generated by line 187 of tool/wiki/sync_runtime_parameter.py. Maybe we can fix it in this PR?

The typo is fixed in #521, you can ignore this comment.

vivi235711 added 4 commits May 5, 2025 14:26

Fix typo and wiki link

f0a1793

Fix error in wiki link

ac4a90b

Update Wiki: Runtime Parameters related to ELBDM

cc70a3f

Add new page for ELBDM runtime parameters Add spectral Interpolation

vivi235711 commented May 8, 2025

View reviewed changes

Minor fix.

fb91a94

vivi235711 marked this pull request as ready for review May 8, 2025 05:13

Add some wiki link to parameter

09a7466

jzuhone changed the base branch from main to v2.2.x May 10, 2025 17:58

vivi235711 changed the base branch from v2.2.x to main June 12, 2025 09:45

hyschive requested a review from hsinhaoHHuang June 23, 2025 07:58

hyschive assigned hsinhaoHHuang Jun 23, 2025

hyschive added enhancement doc Documentation fdm Fuzzy dark matter and removed fdm Fuzzy dark matter labels Jun 23, 2025

hyschive requested review from HsunYeong and removed request for hsinhaoHHuang February 12, 2026 08:32

hyschive assigned HsunYeong and unassigned hsinhaoHHuang Feb 12, 2026

hsinhaoHHuang mentioned this pull request Feb 13, 2026

Update wiki for the runtime parameters #431

Merged

HsunYeong reviewed Mar 9, 2026

View reviewed changes

vivi235711 added 2 commits April 18, 2026 13:49

Modified accoding to @HsunYeong's suggestion

49db1c8

Add brief tutorial for OPT__GRAVITY_EXTRA_MASS Typo fix

Merge branch 'main' into pr/vivi235711/466

3834e24

Resolve conflicts Fix links

vivi235711 added 4 commits April 20, 2026 16:04

[Workflow] Update all parameters wiki page

d1e33e4

Minor

2db1290

Merge branch 'UpdateWiki' of github.com:vivi235711/gamer into pr/vivi…

d19de4a

…235711/466

Add ELBDM_RESCALE_MASS_ERROR and ELBDM_RESCALE_MASS_STEPS

fb5cf27

HsunYeong reviewed Apr 23, 2026

View reviewed changes

	Tfuld be set to either `FIXUP_FLUX_YES` or `FIXUP_FLUX_NO`.
	The second parameter should be set to either `FIXUP_FLUX_YES` or `FIXUP_FLUX_NO`.

Conversation

vivi235711 commented May 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes:

Particles

Timesteps

Refinement

ELBDM (new page)

MPI and OpenMP

Hydro

Gravity

Interpolation

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vivi235711 Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

technic960183 commented Jun 12, 2025

Uh oh!

vivi235711 commented Jun 12, 2025

Uh oh!

jzuhone commented Jun 12, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hyschive commented Mar 14, 2026

Uh oh!

hyschive commented Mar 25, 2026

Uh oh!

hyschive commented Apr 16, 2026

Uh oh!

vivi235711 commented Apr 21, 2026

Uh oh!

hyschive commented Apr 22, 2026

Uh oh!

HsunYeong left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

vivi235711 commented May 6, 2025 •

edited

Loading

vivi235711 Apr 20, 2026 •

edited

Loading