ogstools.feflowlib.templates module#

ogstools.feflowlib.templates.steady_state_diffusion(saving_path, model=None)[source]#

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

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

  • model (OGS | None) – ogs model, which shall be used with the template

Return type:

OGS

ogstools.feflowlib.templates.liquid_flow(saving_path, model=None, dimension2D=False)[source]#

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

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

  • model (OGS | None) – ogs model, which shall be used with the template

  • dimension2D (bool)

Return type:

OGS

ogstools.feflowlib.templates.component_transport(saving_path, species, model=None)[source]#

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

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

  • species (list)

  • model (OGS | None) – ogs model, which shall be used with the template

Return type:

OGS

ogstools.feflowlib.templates.hydro_thermal(saving_path, model=None, dimension2D=False)[source]#

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

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

  • model (OGS | None) – ogs model, which shall be used with the template

  • dimension2D (bool) – to known if the model is 2D or not

Return type:

OGS