gempy.core.data.StructuralGroup

class gempy.core.data.StructuralGroup(name: str, elements: list[~gempy.core.data.structural_element.StructuralElement], structural_relation: ~gempy_engine.core.data.stack_relation_type.StackRelationType, fault_relations: list[~gempy.core.data.structural_group.StructuralGroup] | ~gempy.core.data.structural_group.FaultsRelationSpecialCase | None = None, faults_input_data: ~gempy_engine.core.data.kernel_classes.faults.FaultsData | None = None, custom_interpolation: ~typing.Annotated[~gempy_engine.core.data.interpolation_functions.CustomInterpolationFunctions | None, FieldInfo(annotation=NoneType, required=True, exclude=True)] = None, ignored_grid_types: ~typing.Annotated[tuple[str, ...], FieldInfo(annotation=NoneType, required=True, exclude=True)] = <factory>)[source]

An abstract base class that represents a structural group within a geological model.

Examples using gempy.core.data.StructuralGroup

Video Tutorial “code-along”: Faults

Video Tutorial "code-along": Faults

Basics: Data Classes and Modeling API

Basics: Data Classes and Modeling API

Building a Model from Scratch

Building a Model from Scratch

Alès Basin, France

Alès Basin, France

Claudius, Queensland, Australia

Claudius, Queensland, Australia

Methods

__init__(name, elements, ...)

append_element(element)

get_element_by_name(element_name)

remove_element(element)

Attributes

custom_interpolation

fault_relations

Relations with other groups in terms of faults.

faults_input_data

id

is_fault

is_lithology

number_of_elements

number_of_orientations

number_of_points

solution

Solution related to this group from geological computations.

name

The name of the structural group.

elements

A list of structural elements within the group.

structural_relation

The type of relation between the structural elements in the group.

ignored_grid_types

name: str = <dataclasses._MISSING_TYPE object>

The name of the structural group.

elements: list[StructuralElement] = <dataclasses._MISSING_TYPE object>

A list of structural elements within the group.

structural_relation: StackRelationType = <dataclasses._MISSING_TYPE object>

The type of relation between the structural elements in the group.

fault_relations: list[StructuralGroup] | FaultsRelationSpecialCase | None = None

Relations with other groups in terms of faults.

solution: RawArraysSolution | None = None

Solution related to this group from geological computations.

__init__(name: str, elements: list[~gempy.core.data.structural_element.StructuralElement], structural_relation: ~gempy_engine.core.data.stack_relation_type.StackRelationType, fault_relations: list[~gempy.core.data.structural_group.StructuralGroup] | ~gempy.core.data.structural_group.FaultsRelationSpecialCase | None = None, faults_input_data: ~gempy_engine.core.data.kernel_classes.faults.FaultsData | None = None, custom_interpolation: ~typing.Annotated[~gempy_engine.core.data.interpolation_functions.CustomInterpolationFunctions | None, FieldInfo(annotation=NoneType, required=True, exclude=True)] = None, ignored_grid_types: ~typing.Annotated[tuple[str, ...], FieldInfo(annotation=NoneType, required=True, exclude=True)] = <factory>) None