ogstools.feflowlib.templates module#

ogstools.feflowlib.templates.steady_state_diffusion(saving_path, prj)[source]#

A template for a steady state diffusion process to be simulated in ogs.

Parameters:
  • saving_path (Path) – path of ogs simulation results

  • prj (Project) – ogs project, which shall be used with the template

Return type:

Project

ogstools.feflowlib.templates.liquid_flow(saving_path, prj, dimension=3)[source]#

A template for a steady liquid flow process to be simulated in ogs.

Parameters:
  • saving_path (Path) – path of ogs simulation results

  • prj (Project) – ogs project, which shall be used with the template

  • dimension (int) – True, if the model is 2 dimensional.

Return type:

Project

ogstools.feflowlib.templates.component_transport(saving_path, species, prj, dimension=3, fixed_out_times=None, time_stepping=None, initial_time=1, end_time=1)[source]#

A template for component transport process to be simulated in ogs.

Parameters:
  • saving_path (Path) – path of ogs simulation results

  • species (list)

  • prj (Project) – ogs project, which shall be used with the template

  • dimension (int) – True, if the model is 2 dimensional.

  • time_stepping (list | None) – List of how often a time step should be repeated and its time.

  • initial_time (int) – Beginning of the simulation time.

  • end_time (int) – End of the simulation time.

Return type:

Project

ogstools.feflowlib.templates.hydro_thermal(saving_path, prj, dimension=3)[source]#

A template for a hydro-thermal process to be simulated in ogs.

Parameters:
  • saving_path (Path) – path of ogs simulation results

  • prj (Project) – ogs project, which shall be used with the template

  • dimension (int) – to known if the model is 2D or not

Return type:

Project