ogstools.ogs6py.processes module

class ogstools.ogs6py.processes.Processes

Bases: BuildTree

Class for managing the processes section in the project file.

__init__(tree)

add_process_variable(process_variable='', process_variable_name='')

Adds a process variable.

Parameters:

• process_variable (str)

• process_variable_name (str)

Return type:

None

add_secondary_variable(internal_name, output_name)

Adds a secondary variable.

param: internal_variable: param: output_name:

Return type:

None

set_process(**args)

Set basic process properties. Any pair tag=”value” translates to <tag>value</tag> in process section.

Return type:

None

Parameters

name : str type : str integration_order : str darcy_gravity/specific_body_force : list or tuple

set_constitutive_relation(**args)

Sets constituitive relation.

Return type:

None

Parameters

Any pair property=”parameter_name” translates to <property>parameter_name</property> in constitutive_relation section if more constitutuitive relations are given use id key word.

set_bhe_type(bhe_type, bhe_id=0)

Set a BHE type

Return type:

None

set_bhe_component(bhe_id=0, **args)

Set a BHE component.

Return type:

None

add_surfaceflux(**args)

Add a SurfaceFlux.

Return type:

None

Parameters

mesh : str property_name : str

Raises

KeyError

DESCRIPTION.

Returns

None.

set_ice_constitutive_relation(*, id=None, **args)

Sets ice constituitive relation.

Parameters:

args (Any) – Keyword arguments describing the constitutive relation. Any property="parameter_name" pair is translated to <property>parameter_name</property> in the ice_constitutive_relation section.

Example:

>>> project.processes.set_ice_constitutive_relation(
...     type="LinearElasticIsotropic",
...     youngs_modulus="E",
...     poissons_ratio="nu",
... )

Return type:

None