ogstools.studies.convergence.study module#
- ogstools.studies.convergence.study.run_convergence_study(output_name, mesh_paths, variable_name, timevalue=0.0, refinement_ratio=2.0, reference_solution_path=None, prepare_only=False, show_progress=False)[source]#
Run a convergence study.
- Parameters:
output_name (
Path) – The output path for the Jupyter notebook.mesh_paths (
list[Path]) – mesh paths of increasing resolutions.variable_name (
str) – The variable to study for convergence.timevalue (
float) – The time value for analysis.refinement_ratio (
float) – The refinement ratio between the meshes.reference_solution_path (
Path|None) – Optional reference solution for comparison.prepare_only (
bool) – If True, don’t execute the notebook.show_progress (
bool) – If True, display a progress bar.
- Return type:
returns: None, but generates the convergence study notebook.