-
Notifications
You must be signed in to change notification settings - Fork 76
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.
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
Open
vivi235711
wants to merge
6
commits into
gamer-project:main
Choose a base branch
from
vivi235711:UpdateWiki
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Update wiki #466
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
c8cd705
Update Wiki: InputParameters Runtime Parameters
vivi235711 f0a1793
Fix typo and wiki link
vivi235711 ac4a90b
Fix error in wiki link
vivi235711 cc70a3f
Update Wiki: Runtime Parameters related to ELBDM
vivi235711 fb91a94
Minor fix.
vivi235711 09a7466
Add some wiki link to parameter
vivi235711 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
|
|
||
| ## Compilation Options | ||
|
|
||
| Related options: | ||
| [[--model | Installation:-Option-List#--model]], | ||
| [[--elbdm_scheme | Installation:-Option-List#--elbdm_scheme]], | ||
| [[--wave_scheme | Installation:-Option-List#--wave_scheme]], | ||
| [[--conserve_mass | Installation:-Option-List#--conserve_mass]], | ||
| [[--laplacian_four | Installation:-Option-List#--laplacian_four]], | ||
| [[--gramfe_scheme | Installation:-Option-List#--gramfe_scheme]], | ||
| [[--hybrid_scheme | Installation:-Option-List#--hybrid_scheme]], | ||
| [[--self_interaction | Installation:-Option-List#--self_interaction]], | ||
|
|
||
|
|
||
| ## Runtime Parameters | ||
| [[Runtime parameters: ELBDM | Runtime-Parameters:-ELBDM]] | ||
|
|
||
| Other related parameters: | ||
| [[ OPT__INT_PHASE | Runtime-Parameters:-Interpolation#OPT__INT_PHASE]], | ||
| [[ OPT__LB_EXCHANGE_FATHER | Runtime-Parameters:-MPI-and-OpenMP#OPT__LB_EXCHANGE_FATHER]], | ||
| [[ OPT__FLAG_ENGY_DENSITY | Runtime-Parameters:-Refinement#OPT__FLAG_ENGY_DENSITY]], | ||
| [[ OPT__FLAG_INTERFERENCE | Runtime-Parameters:-Refinement#OPT__FLAG_INTERFERENCE]], | ||
| [[ OPT__FLAG_SPECTRAL | Runtime-Parameters:-Refinement#OPT__FLAG_SPECTRAL]], | ||
| [[ OPT__FLAG_SPECTRAL_N | Runtime-Parameters:-Refinement#OPT__FLAG_SPECTRAL_N]], | ||
| [[ DT__PHASE | Runtime-Parameters:-Timestep#DT__PHASE]], | ||
| [[ DT__HYBRID_CFL | Runtime-Parameters:-Timestep#DT__HYBRID_CFL]], | ||
| [[ DT__HYBRID_CFL_INIT | Runtime-Parameters:-Timestep#DT__HYBRID_CFL_INIT]], | ||
| [[ DT__HYBRID_VELOCITY | Runtime-Parameters:-Timestep#DT__HYBRID_VELOCITY]], | ||
| [[ DT__HYBRID_VELOCITY_INIT | Runtime-Parameters:-Timestep#DT__HYBRID_VELOCITY_INIT]], | ||
|
|
||
| ## Remarks | ||
|
|
||
|
|
||
| <br> | ||
|
|
||
| ## Links | ||
| * [[Main page of Physics Modules | Physics-Modules]] | ||
| * [[Main page of Runtime Parameters | Runtime Parameters]] |
68 changes: 34 additions & 34 deletions
68
doc/wiki/Runtime-Parameters-related/Runtime-Parameters:-All.md
Large diffs are not rendered by default.
Oops, something went wrong.
154 changes: 154 additions & 0 deletions
154
doc/wiki/Runtime-Parameters-related/Runtime-Parameters:-ELBDM.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| Parameters described on this page: | ||
| [ELBDM_MASS](#ELBDM_MASS), | ||
| [ELBDM_PLANCK_CONST](#ELBDM_PLANCK_CONST), | ||
| [ELBDM_LAMBDA](#ELBDM_LAMBDA), | ||
| [ELBDM_TAYLOR3_COEFF](#ELBDM_TAYLOR3_COEFF), | ||
| [ELBDM_TAYLOR3_AUTO](#ELBDM_TAYLOR3_AUTO), | ||
| [ELBDM_REMOVE_MOTION_CM](#ELBDM_REMOVE_MOTION_CM), | ||
| [ELBDM_BASE_SPECTRAL](#ELBDM_BASE_SPECTRAL), | ||
| [ELBDM_MATCH_PHASE](#ELBDM_MATCH_PHASE), | ||
| [ELBDM_FIRST_WAVE_LEVEL](#ELBDM_FIRST_WAVE_LEVEL), | ||
| [OPT__RES_PHASE](#OPT__RES_PHASE), | ||
| [SPEC_INT_TABLE_PATH](#SPEC_INT_TABLE_PATH), | ||
| [SPEC_INT_XY_INSTEAD_DEPHA](#SPEC_INT_XY_INSTEAD_DEPHA), | ||
| [SPEC_INT_VORTEX_THRESHOLD](#SPEC_INT_VORTEX_THRESHOLD), | ||
| [SPEC_INT_GHOST_BOUNDARY](#SPEC_INT_GHOST_BOUNDARY) | ||
|
|
||
| Parameters below are shown in the format:   **`Name`   (Valid Values)   [Default Value]** | ||
|
|
||
| <a name="ELBDM_MASS"></a> | ||
| * #### `ELBDM_MASS`   (>0)   [none] | ||
| * **Description:** | ||
| Particle mass in ev/c^2. | ||
| (Input unit is fixed even when OPT__UNIT or COMOVING is on) | ||
| * **Restriction:** | ||
|
|
||
| <a name="ELBDM_PLANCK_CONST"></a> | ||
| * #### `ELBDM_PLANCK_CONST`   (>0)   [conform to the unit system set by [[OPT__UNIT | Runtime-Parameters:-Units#OPT__UNIT]] or [[--comoving | Installation:-Option-List#--comoving]]] | ||
| * **Description:** | ||
| Reduced planck constant in g.cm^2/s^2. | ||
| * **Restriction:** | ||
| It will be overwritten by the default value when [[OPT__UNIT | Runtime-Parameters:-Units#OPT__UNIT]] or [[--comoving | Installation:-Option-List#--comoving]] | ||
| is on; no default when [[OPT__UNIT | Runtime-Parameters:-Units#OPT__UNIT]] and | ||
| [[--comoving | Installation:-Option-List#--comoving]] is off. | ||
|
|
||
| <a name="ELBDM_LAMBDA"></a> | ||
| * #### `ELBDM_LAMBDA`   (none)   [1] | ||
| * **Description:** | ||
| Quartic self-interaction coefficient in ELBDM. | ||
| * **Restriction:** | ||
|
|
||
| <a name="ELBDM_TAYLOR3_COEFF"></a> | ||
| * #### `ELBDM_TAYLOR3_COEFF`   (≥0.125)   [1.0/6.0] | ||
| * **Description:** | ||
| Coefficient for the 3rd-order Taylor expansion of the wave function. | ||
| Values below 0.125 are always unstable. | ||
| Values ≤ 1/6 become unstable if | ||
| [[DT__FLUID | Runtime-Parameters:-Timestep#DT__FLUID]] > | ||
| $\sqrt{3}\pi/8$ or $\sqrt{27}\pi/32$ (when [[--laplacian_four | Installation:-Option-List#--laplacian_four]] is enabled). | ||
| * **Restriction:** | ||
| Only applicable when the compilation option | ||
| [[ --wave_scheme | Installation:-Option-List#--wave_scheme ]] = `FD`. | ||
| Ignored if [ELBDM_TAYLOR3_AUTO](#ELBDM_TAYLOR3_AUTO) is enable. | ||
|
|
||
| * #### `ELBDM_TAYLOR3_AUTO`   (none)   [0] | ||
| * **Description:** | ||
| If this parameter is set to 1, the code will automatically determine the coefficient | ||
| [ELBDM_TAYLOR3_COEFF](#ELBDM_TAYLOR3_COEFF) to minimize the amplitude error | ||
| for the smallest wavelength. | ||
| * **Restriction:** | ||
| Useless if [[ OPT__FREEZE_FLUID | Runtime-Parameters:-Hydro#OPT__FREEZE_FLUID]] is on. | ||
|
|
||
| <a name="ELBDM_REMOVE_MOTION_CM"></a> | ||
| * #### `ELBDM_REMOVE_MOTION_CM`   (0=none, 1=init, 2=every step)   [0] | ||
| * **Description:** | ||
| Remove the motion of center-of-mass. | ||
| * **Restriction:** | ||
| Only applicable when enabled | ||
| [[ OPT__CK_CONSERVATION | Runtime-Parameters:-Miscellaneous#OPT__CK_CONSERVATION ]]. | ||
| Not supported when | ||
| [[ --bitwise_reproducibility | Installation:-Option-List#--bitwise_reproducibility ]] = true. | ||
|
|
||
| <a name="ELBDM_BASE_SPECTRAL"></a> | ||
| * #### `ELBDM_BASE_SPECTRAL`   (0=off, 1=on)   [0] | ||
| * **Description:** | ||
| Adopt the spectral method to evolve base-level wave function. | ||
| * **Restriction:** | ||
| Requires [[--fftw | Installation:-Option-List#--fftw]] = FFTW2/FFTW | ||
| and periodic boundary conditions for all directions: | ||
| [[OPT__BC_FLU | Runtime-Parameters:-Hydro#OPT__BC_FLU_XM]] = 1. | ||
|
|
||
| <a name="ELBDM_MATCH_PHASE"></a> | ||
| * #### `ELBDM_MATCH_PHASE`   (0=off, 1=on)   [1] | ||
| * **Description:** | ||
| Match child phases with father phases during data restriction. | ||
| * **Restriction:** | ||
| Only applicable when enabling the compilation option | ||
| [[ --elbdm_scheme | Installation:-Option-List#--elbdm_scheme]] = `HYBRID`. | ||
| Requires [[ OPT__UM_IC_LEVEL | Runtime-Parameters:-Initial-Conditions#OPT__UM_IC_LEVEL ]] | ||
| ≥ [ELBDM_FIRST_WAVE_LEVEL](#ELBDM_FIRST_WAVE_LEVEL). | ||
|
|
||
| <a name="ELBDM_FIRST_WAVE_LEVEL"></a> | ||
| * #### `ELBDM_FIRST_WAVE_LEVEL`   (1 ≤ input ≤ [[ MAX_LEVEL | Runtime-Parameters:-Refinement#MAX_LEVEL]])   [none] | ||
| * **Description:** | ||
| Level at which to switch to the wave solver. | ||
| * **Restriction:** | ||
| Only applicable when enabling the compilation option | ||
| [[ --elbdm_scheme | Installation:-Option-List#--elbdm_scheme]] = `HYBRID`. | ||
|
|
||
| <a name="OPT__RES_PHASE"></a> | ||
| * #### `OPT__RES_PHASE`   (0=off, 1=on)   [0] | ||
| * **Description:** | ||
| Restriction on phase. (i.e., the averages of fine-grid data equal the coarse-grid data) | ||
| * **Restriction:** | ||
|
|
||
| <a name="SPEC_INT_TABLE_PATH"></a> | ||
| * #### `SPEC_INT_TABLE_PATH`   (none)   [none] | ||
| * **Description:** | ||
| Path to the table of the spectral interpolation. | ||
| See [[ ELBDM Spectral Interpolation | ELBDM-Spectral-Interpolation]] for details. | ||
| Table download script is available at | ||
| `example/test_problem/ELBDM/LSS_Hybrid/download_spectral_interpolation_tables.sh`. | ||
| * **Restriction:** | ||
| Only applicable when the enabling compilation option | ||
| [[ --spectral_interpolation | Installation:-Option-List#--spectral_interpolation]] | ||
| and [[ Interpolation schemes | Runtime-Parameters:-Interpolation##INT_TABLE]] = 8. | ||
|
|
||
| <a name="SPEC_INT_XY_INSTEAD_DEPHA"></a> | ||
| * #### `SPEC_INT_XY_INSTEAD_DEPHA`   (0=off, 1=on)   [1] | ||
| * **Description:** | ||
| Interpolate x and y (real and imaginary parts in current implementation) around vortices | ||
| instead of density and phase for the spectral interpolation, | ||
| which has the advantage of being well-defined across vortices | ||
| * **Restriction:** | ||
| Only applicable when the enabling compilation option | ||
| [[ --spectral_interpolation | Installation:-Option-List#--spectral_interpolation]] | ||
| and [[ Interpolation schemes | Runtime-Parameters:-Interpolation##INT_TABLE]] = 8. | ||
|
|
||
| <a name="SPEC_INT_VORTEX_THRESHOLD"></a> | ||
| * #### `SPEC_INT_VORTEX_THRESHOLD`   (≥0)   [0.1] | ||
| * **Description:** | ||
| Vortex detection threshold for [SPEC_INT_XY_INSTEAD_DEPHA](#SPEC_INT_XY_INSTEAD_DEPHA), | ||
| triggered when Lap(S) * dx**2 > threshold, indicating a significant phase jump. | ||
| * **Restriction:** | ||
| Only applicable when the enabling compilation option | ||
| [[ --spectral_interpolation | Installation:-Option-List#--spectral_interpolation]] | ||
| and [[ Interpolation schemes | Runtime-Parameters:-Interpolation##INT_TABLE]] = 8. | ||
|
|
||
| <a name="SPEC_INT_GHOST_BOUNDARY"></a> | ||
| * #### `SPEC_INT_GHOST_BOUNDARY`   (≥1)   [4] | ||
| * **Description:** | ||
| Ghost boundary size for spectral interpolation. | ||
| * **Restriction:** | ||
| Only applicable when the enabling compilation option | ||
| [[ --spectral_interpolation | Installation:-Option-List#--spectral_interpolation]] | ||
| and [[ Interpolation schemes | Runtime-Parameters:-Interpolation##INT_TABLE]] = 8. | ||
|
|
||
| ## Remarks | ||
|
|
||
|
|
||
| <br> | ||
|
|
||
| ## Links | ||
| * [[Main page of Runtime Parameters | Runtime Parameters]] | ||
| * [[Main page of ELBDM | ELBDM]] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?