ogstools.ogs6py.processvars module#

class ogstools.ogs6py.processvars.ProcessVars[source]#

Bases: BuildTree

Managing the process variables section in the project file.

__init__(tree)[source]#
set_ic(process_variable_name, components, order, initial_condition, **kwargs)[source]#

Set initial conditions.

For more details of the available arguments see https://doxygen.opengeosys.org/stable/d8/db8/ogs_file_param__prj__process_variables__process_variable.html

Parameters:

  • process_variable_name (str) – name of the process variable

  • components (int | str) – number of components

  • order (int | str) – polynomial order of shape functions

  • initial_condition (str) – name of parameter holding the values of the initial condition

Return type:

None

add_bc(process_variable_name, type, **kwargs)[source]#

Adds a boundary condition.

Depending on the type of boundary condition different additional arguments need to be provided. For reference see https://doxygen.opengeosys.org/stable/d1/de4/ogs_file_param__prj__process_variables__process_variable__boundary_conditions__boundary_condition.html

Parameters:

  • process_variable_name (str) – name of the process variable

  • type (str) – type of the boundary condition

Return type:

None

add_st(process_variable_name, type, **kwargs)[source]#

Add a source term.

Depending on the type of source term different additional arguments need to be provided. For reference see https://doxygen.opengeosys.org/stable/dc/dfc/ogs_file_param__prj__process_variables__process_variable__source_terms__source_term.html

Parameters:

  • process_variable_name (str) – name of the process variable

  • type (str) – type of the source term

Return type:

None

deactivate_subdomain(process_variable_name, **kwargs)[source]#

Deactivate subdomain/s for a specific process variable.

https://doxygen.opengeosys.org/stable/da/d70/ogs_file_param__prj__process_variables__process_variable__deactivated_subdomains__deactivated_subdomain.html

Parameters:

process_variable_name (str) – name of the process variable

Return type:

None