NodeRegion

NodeRegion

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

Bases: RegionBase

A region defined by a set of nodes or a range of node tags.

NodeRegion groups a collection of nodes (specified as a list or a tag range) into a named structural region. This allows targeted assignments such as node-based recorders or specialized damping properties in OpenSees.

Tcl form

region <tag> -node <nodeTags...> or region <tag> -nodeRange <start> <end>

Note

• Only one of nodes or node_range can be provided.
• Renders with -nodeOnly or -nodeRangeOnly if node_only is set to True.

Example

from femora.core.model import Model

model = Model()
# Create a node-based region for node tags 1, 2, and 3
reg = model.region.node(
    user_name="foundation_nodes",
    nodes=[1, 2, 3],
)
print(reg.tag)

Create a node-based region.

Parameters:

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

Raises:

Type	Description
ValueError	If both nodes and node_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 "NodeRegion".