ElementRegion

ElementRegion

ElementRegion(damping: Damping = None, **kwargs)

Bases: RegionBase

A region defined by a set of elements or a range of element tags.

ElementRegion groups a collection of elements (specified as an explicit list or tag range) into a named structural region. This is useful for assigning element-specific damping models (such as Rayleigh damping) in OpenSees.

Tcl form

region <tag> -ele <eleTags...> or region <tag> -eleRange <start> <end>

Note

• Only one of elements or element_range can be provided.
• Renders with -eleOnly or -eleRangeOnly if element_only is set to True.

Example

from femora.core.model import Model

model = Model()
# Create an element-based region for elements 1 to 10
reg = model.region.element(
    user_name="story_one_elements",
    element_range=[1, 10],
)
print(reg.tag)

Create an element-based region.

Parameters:

Name	Type	Description	Default
damping	Damping	Optional Damping component to assign to the elements in this region.	None
**kwargs		Key-value arguments including: user_name: Unique name of the region. elements: Optional list or array of explicit element tags. element_range: Optional list/tuple of two integers [start, end]. element_only: Optional boolean. If True, includes only the elements.	{}

Raises:

Type	Description
ValueError	If both elements and element_range are specified, or if the input formats are invalid.

Methods:

get_type staticmethod

get_type() -> str

Get the region type name.

Returns:

Type	Description
str	The string "ElementRegion".