Skip to content

Commit 4bc521b

Browse files
committed
Update parmmg readmes
1 parent 539c90d commit 4bc521b

File tree

2 files changed

+19
-19
lines changed
  • parmmg_remeshing_examples/use_cases

2 files changed

+19
-19
lines changed

parmmg_remeshing_examples/use_cases/body_fitted_hessian_cylinder3D/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,27 +40,27 @@ Some of the main settings to control and customize are:
4040

4141
In [ProjectParameters.json](source/ProjectParameters.json):
4242

43-
- ["end_time" to change the total length of the simulation](source/ProjectParameters.json#L7)
44-
- ["time_step" to change the time step used](source/ProjectParameters.json#L67)
45-
- ["statistics_start_point_control_value", in case AVERAGE quantities are to be used, to set the inital time_step to compute statitcs](source/ProjectParameters.json#L164)
43+
- ["end_time"](source/ProjectParameters.json#L7) to change the total length of the simulation
44+
- ["time_step"](source/ProjectParameters.json#L67) to change the time step used
45+
- ["statistics_start_point_control_value"](source/ProjectParameters.json#L164), in case AVERAGE quantities are to be used, to set the inital time_step to compute statitcs
4646

4747

4848
In [RemeshingParameters.json](source/RemeshingParameters.json):
4949

50-
- ["number_of_iterations" to change the total number of consecutive resolution+remeshing of the simulation](source/RemeshingParameters.json#L2)
51-
- ["perform_mapping_between_steps" if it is set to `True`, it will map the solution on step `n` to the mesh `n+1`. Set it to `False` to start the simulation from rest at every new step.](source/RemeshingParameters.json#L3)
50+
- ["number_of_iterations"](source/RemeshingParameters.json#L2) to change the total number of consecutive resolution+remeshing of the simulation.
51+
- ["perform_mapping_between_steps"](source/RemeshingParameters.json#L3) if it is set to `True`, it will map the solution on step `n` to the mesh `n+1`. Set it to `False` to start the simulation from rest at every new step.
5252

53-
### If "perform_mapping_between_steps" is `True`
54-
- ["search_radius" to specify the radius that the mapper will use to perform the mapping. WARNING: setting high values of the search_radius might slow down the mapping.](source/RemeshingParameters.json#L8)
53+
If "perform_mapping_between_steps" is `True`
54+
- ["search_radius"](source/RemeshingParameters.json#L8) to specify the radius that the mapper will use to perform the mapping. WARNING: setting high values of the search_radius might slow down the mapping.
5555

56-
- ["variables_to_remesh" to specify the variables of the old mesh to be used to remesh the new mesh.](source/RemeshingParameters.json#L11)
56+
- ["variables_to_remesh"](source/RemeshingParameters.json#L11) to specify the variables of the old mesh to be used to remesh the new mesh.
5757
- `VELOCITY`: This will use the velocity at each time step, starting from the [start_time_control_value](source/RemeshingParameters.json#L12).
5858
- `PRESSURE`: This will use the pressure at each time step, starting from the [start_time_control_value](source/RemeshingParameters.json#L12).
5959
- `AVERAGE_VELOCITY`: This will use the AVERAGE velocity across the simulation, starting from the [statistics_start_point_control_value](source/ProjectParameters.json#L164).
6060
- `AVERAGE_PRESSURE`: This will use the AVERAGE pressure across the simulation, starting from the [statistics_start_point_control_value](source/ProjectParameters.json#L164).
6161

62-
- ["start_time_control_value" to set the starting time to start computing the metrics if `VELOCITY` or `PRESSURE` are chosen as variables to remesh the variables of the old mesh to be used to remesh the new mesh.](source/RemeshingParameters.json#L12)
62+
- ["start_time_control_value"](source/RemeshingParameters.json#L12) to set the starting time to start computing the metrics if `VELOCITY` or `PRESSURE` are chosen as variables to remesh the variables of the old mesh to be used to remesh the new mesh.
6363

64-
- ["minimal_size" to set the minimal size of the mesh. WARNING: This only works as a truncation value. It is recomended to control the size of the mesh using the `interpolation_error` only.](source/RemeshingParameters.json#L14)
65-
- ["maximal_size" to set the maximal size of the mesh. WARNING: This only works as a truncation value. It is recomended to control the size of the mesh using the `interpolation_error` only.](source/RemeshingParameters.json#L15)
66-
- ["interpolation_error" to set the error that the remesher will prescribe on the output mesh. Lowering the interpolation error will result in more nodal presence and smaller sized elemnts.](source/RemeshingParameters.json#L21)
64+
- ["interpolation_error"](source/RemeshingParameters.json#L21) to set the error that the remesher will prescribe on the output mesh. Lowering the interpolation error will result in more nodal presence and smaller sized elemnts.
65+
- ["minimal_size"](source/RemeshingParameters.json#L14) to set the minimal size of the mesh. WARNING: This only works as a truncation value. It is recomended to control the size of the mesh using the ["interpolation_error"](source/RemeshingParameters.json#L21) only.
66+
- ["maximal_size"](source/RemeshingParameters.json#L15) to set the maximal size of the mesh. WARNING: This only works as a truncation value. It is recomended to control the size of the mesh using the ["interpolation_error"](source/RemeshingParameters.json#L21) only.

parmmg_remeshing_examples/use_cases/embedded_level_set_building3D/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,13 @@ Velocity field
3737

3838
In [ProjectParameters.json](source/ProjectParameters.json):
3939

40-
- ["end_time" to change the total length of the simulation](source/ProjectParameters.json#L6)
41-
- ["time_step" to change the time step used](source/ProjectParameters.json#L64)
40+
- ["end_time"](source/ProjectParameters.json#L6) to change the total length of the simulation.
41+
- ["time_step"](source/ProjectParameters.json#L64) to change the time step used.
4242

4343
In [RemeshingParameters.json](source/RemeshingParameters.json):
4444

45-
- ["number_of_iterations" to change the total number of consecutive remeshing steps.](source/RemeshingParameters.json#L2)
46-
- ["minimal_size" to set the minimal size of the mesh. This will be the size set at `distance=0.0'.](source/RemeshingParameters.json#L4)
47-
- ["maximal_size" to set the maximal size of the mesh. This will be the size set at `distance=boujdary_layer_max_distance'.](source/RemeshingParameters.json#L5)
48-
- ["boundary_layer_max_distance" to set the distance up to where the refinement will be performed. Elements outside this distance will keep its initial size.'.](source/RemeshingParameters.json#L8)
49-
- ["interpolation" to set the interpolation set between the minimal_size and the maximal_size. Possible interpolation settings are: `constant`, `linear`, `exponential`.'](source/RemeshingParameters.json#L9)
45+
- ["number_of_iterations"](source/RemeshingParameters.json#L2) to change the total number of consecutive remeshing steps.
46+
- ["minimal_size"](source/RemeshingParameters.json#L4) to set the minimal size of the mesh. This will be the size set at `distance=0.0'.
47+
- ["maximal_size"](source/RemeshingParameters.json#L5) to set the maximal size of the mesh. This will be the size set at `distance=boundary_layer_max_distance'.
48+
- ["boundary_layer_max_distance"](source/RemeshingParameters.json#L8) to set the distance up to where the refinement will be performed. Elements outside this distance will keep its initial size.
49+
- ["interpolation"](source/RemeshingParameters.json#L9) to set the interpolation set between the minimal_size and the maximal_size. Possible interpolation settings are: `constant`, `linear`, `exponential`.

0 commit comments

Comments
 (0)