Skip to content

Update wiki #466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
vivi235711 wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Update wiki #466

vivi235711 wants to merge 6 commits into from

Conversation

@vivi235711
Copy link
Contributor

@vivi235711 vivi235711 commented May 6, 2025 •
edited
Loading

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 |

vivi235711 added 4 commits May 5, 2025 14:26
@vivi235711
Update Wiki: InputParameters Runtime Parameters
c8cd705 
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.
@vivi235711
Fix typo and wiki link
f0a1793
@vivi235711
Fix error in wiki link
ac4a90b
@vivi235711
Update Wiki: Runtime Parameters related to ELBDM
cc70a3f 
Add new page for ELBDM runtime parameters
Add spectral Interpolation
vivi235711
vivi235711 commented May 8, 2025
View reviewed changes
doc/wiki/Runtime-Parameters-related/Runtime-Parameters:-MPI-and-OpenMP.md
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>
Copy link
Contributor Author

@vivi235711 vivi235711 May 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

doc/wiki/Runtime-Parameters-related/Runtime-Parameters:-ELBDM.md
Copy link
Contributor Author

@vivi235711 vivi235711 May 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

doc/wiki/Runtime-Parameters-related/Runtime-Parameters:-Gravity.md
* **Restriction:**

OPT__GRAVITY_EXTRA_MASS
<a name="OPT__GRAVITY_EXTRA_MASS"></a>
Copy link
Contributor Author

@vivi235711 vivi235711 May 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@vivi235711 vivi235711 marked this pull request as ready for review May 8, 2025 05:13
@jzuhone jzuhone changed the base branch from main to v2.2.x May 10, 2025 17:58
@technic960183
Copy link
Member

technic960183 commented Jun 12, 2025

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 vivi235711 changed the base branch from v2.2.x to main June 12, 2025 09:45
@vivi235711
Copy link
Contributor Author

vivi235711 commented Jun 12, 2025

@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
Copy link
Collaborator

jzuhone commented Jun 12, 2025

@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.

@hyschive hyschive requested a review from hsinhaoHHuang June 23, 2025 07:58
@hyschive hyschive added enhancement doc Documentation fdm Fuzzy dark matter and removed fdm Fuzzy dark matter labels Jun 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hsinhaoHHuang hsinhaoHHuang Awaiting requested review from hsinhaoHHuang

Assignees

@hsinhaoHHuang hsinhaoHHuang

Labels

doc Documentation enhancement

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Fill in the missing parameter information

5 participants

@vivi235711 @technic960183 @jzuhone @hyschive @hsinhaoHHuang