From 65e7f89cd3ba15a3b4ffadc1c2e25477a91abcce Mon Sep 17 00:00:00 2001 From: Chun-Yen Chen <70311975+ChunYen-Chen@users.noreply.github.com> Date: Sun, 8 Sep 2024 13:12:49 +0800 Subject: [PATCH] Update README.md --- .../Hydro/ParticleEquilibriumIC/README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/example/test_problem/Hydro/ParticleEquilibriumIC/README.md b/example/test_problem/Hydro/ParticleEquilibriumIC/README.md index 0c570a94e..9bbfa2937 100644 --- a/example/test_problem/Hydro/ParticleEquilibriumIC/README.md +++ b/example/test_problem/Hydro/ParticleEquilibriumIC/README.md @@ -11,7 +11,7 @@ # Default setup -`OPT__FREEZE_FLUID` 1 +[[OPT__FREEZE_FLUID | Hydro#OPT__FREEZE_FLUID]] = 1 # Note @@ -21,16 +21,18 @@ 2. Test the evolution of all sorts of models, like Plummer, NFW, Burkert, Jaffe, Hernquist, Einasto. To switch among different models, set `Cloud_Type` in your physical parameter files. + Available options include: - `Plummer`, `NFW`, `Burkert`, `Jaffe`, `Hernquist`, `Einasto`, `Table` + `Plummer`, `NFW`, `Burkert`, `Jaffe`, `Hernquist`, `Einasto`, and `Table` If you want to initialize a model with a given tabular density profile, use the option `Table` and input your file name in `Density_Table_Name` in your physical parameter files; otherwise input `NONE`. -3. Sometimes the spatial resolution is not high enough for some models like Jaffe. Please increase `MAX_LEVEL` in `Input__Parameter`. +4. Sometimes the spatial resolution is not high enough for some models like Jaffe. + Please increase [[MAX_LEVEL | Runtime-Parameters:-Refinement#MAX_LEVEL]] in `Input__Parameter`. -4. You can construct multiple clouds of particles at the same time. +5. You can construct multiple clouds of particles at the same time. For example, replace `Input__TestProb` with `Input_TestProb_Double` will allow you to construct two clouds of particles. For details, you may check `Input__TestProb` for further instructions. -5. To generate example density or external potential tables, you may use the python files in `tool/table_maker/`. +6. To generate example density or external potential tables, you may use the python files in `tool/table_maker/`.