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 (Path) – 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, 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
model (OGS | None) – ogs model, which shall be used with the template
dimension (int) – True, if the model is 2 dimensional.
- Return type:
OGS
- ogstools.feflowlib.templates.component_transport(saving_path, species, model=None, dimension=3, fixed_out_times=None)[source]#
A template for component transport process to be simulated in ogs.
- Parameters:
saving_path (Path) – path of ogs simulation results
species (list)
model (OGS | None) – ogs model, which shall be used with the template
dimension (int) – True, if the model is 2 dimensional.
fixed_out_times (list | None)
- Return type:
OGS
- ogstools.feflowlib.templates.hydro_thermal(saving_path, model=None, dimension=3)[source]#
A template for a hydro-thermal process to be simulated in ogs.
- Parameters:
saving_path (Path) – path of ogs simulation results
model (OGS | None) – ogs model, which shall be used with the template
dimension (int) – to known if the model is 2D or not
- Return type:
OGS