# Member Loads functions | OpenStaad Python

> Loads on members — uniform, concentrated, trapezoidal, linearly varying, fixed-end, area, and floor loads.

Source: https://www.openstaad.com/docs/member-loads

Every function is a method of the session `s = ops.connect()` (`from openstaad import ops`).

## Add

### AddMemberAreaLoad

**Description**

Adds the member area load.

**Parameters**

- `beamIds` (list): beam ids.
- `load` (float): load.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.AddMemberAreaLoad([1, 2], 1.0)
print(result)
```

### AddMemberConcForce

**Description**

Adds the member conc force.

**Parameters**

- `beamIds` (list): beam ids.
- `varDirection` (int): var direction.
- `varForce` (float): var force.
- `varD1` (float): var d 1.
- `varD2` (float): var d 2.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.AddMemberConcForce([1, 2], 1, 1.0, 1.0, 1.0)
print(result)
```

### AddMemberConcMoment

**Description**

Adds the member conc moment.

**Parameters**

- `beamIds` (list): beam ids.
- `varDirection` (int): var direction.
- `varMoment` (float): var moment.
- `varD1` (float): var d 1.
- `varD2` (float): var d 2.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.AddMemberConcMoment([1, 2], 1, 1.0, 1.0, 1.0)
print(result)
```

### AddMemberFixedEnd

**Description**

Adds the member fixed end.

**Parameters**

- `beamIds` (list): beam ids.
- `loadStart` (list[float]): load start.
- `loadEnd` (list[float]): load end.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.AddMemberFixedEnd([1, 2], [1, 2], [1, 2])
print(result)
```

### AddMemberFloorLoad

**Description**

Adds the member floor load.

**Parameters**

- `varPressure` (float): var pressure.
- `varYMIN` (float): var YMIN.
- `varYMAX` (float): var YMAX.
- `varZMIN` (float): var ZMIN.
- `varZMAX` (float): var ZMAX.
- `varXMIN` (float): var XMIN.
- `varXMAX` (float): var XMAX.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.AddMemberFloorLoad(1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0)
print(result)
```

### AddMemberFloorLoadEx

**Description**

Adds the member floor load ex.

**Parameters**

- `rangeType` (int): range type.
- `loadDirection` (int): load direction.
- `pressure` (float): pressure.
- `grpOrOneWay` (int): grp or one way.
- `yMIN` (float): y MIN.
- `yMAX` (float): y MAX.
- `zMIN` (float): z MIN.
- `zMAX` (float): z MAX.
- `xMIN` (float): x MIN.
- `xMAX` (float): x MAX.

**Returns**

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.AddMemberFloorLoadEx(1, 1, 1.0, 1, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0)
print(result)
```

### AddMemberLinearVari

**Description**

Adds the member linear vari.

**Parameters**

- `memberIds` (list): member ids.
- `varDirection` (int): var direction.
- `varW1` (float): var w 1.
- `varW2` (float): var w 2.
- `varW3` (float): var w 3.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.AddMemberLinearVari([1, 2], 1, 1.0, 1.0, 1.0)
print(result)
```

### AddMemberTrapezoidal

**Description**

Adds the member trapezoidal.

**Parameters**

- `memberIds` (list): member ids.
- `varDirection` (int): var direction.
- `varW1` (float): var w 1.
- `varW2` (float): var w 2.
- `varD1` (float): var d 1.
- `varD2` (float): var d 2.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.AddMemberTrapezoidal([1, 2], 1, 1.0, 1.0, 1.0, 1.0)
print(result)
```

### AddMemberUniformForce

**Description**

Adds the member uniform force.

**Parameters**

- `beamIds` (list): beam ids.
- `varDirection` (int): var direction.
- `varForce` (float): var force.
- `varD1` (float): var d 1.
- `varD2` (float): var d 2.
- `varD3` (float): var d 3.

**Returns**

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.AddMemberUniformForce([1, 2], 1, 1.0, 1.0, 1.0, 1.0)
print(result)
```

### AddMemberUniformMoment

**Description**

Adds the member uniform moment.

**Parameters**

- `beamIds` (list): beam ids.
- `varDirection` (int): var direction.
- `varMoment` (float): var moment.
- `varD1` (float): var d 1.
- `varD2` (float): var d 2.
- `varD3` (float): var d 3.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.AddMemberUniformMoment([1, 2], 1, 1.0, 1.0, 1.0, 1.0)
print(result)
```

## Get

### GetBeamCountAtFloor

**Description**

Returns the beam count at floor.

**Parameters**

- `varfMinX` (float): varf min x.
- `varfMaxX` (float): varf max x.
- `varfMinY` (float): varf min y.
- `varfMaxY` (float): varf max y.
- `varfMinZ` (float): varf min z.
- `varfMaxZ` (float): varf max z.
- `varnDirection` (int): varn direction.

**Returns**

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.GetBeamCountAtFloor(1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1)
print(result)
```

### GetMemberLoadInfo

**Description**

Returns the member load info.

**Parameters**

- `loadIndex` (int): load index.

**Returns**

tuple: A tuple of `(int, list[float], list[float])`.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.GetMemberLoadInfo(1)
print(result)
```

### GetTrapLoadCount

**Description**

Returns the trap load count.

**Parameters**

- `nBeamNo` (int): n beam no.

**Returns**

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.GetTrapLoadCount(1)
print(result)
```

### GetTrapLoads

**Description**

Returns the trap loads.

**Parameters**

- `nBeamNo` (int): n beam no.

**Returns**

list: A list of values.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.GetTrapLoads(1)
print(result)
```

### GetUDLLoadCount

**Description**

Returns the UDL load count.

**Parameters**

- `nBeamNo` (int): n beam no.

**Returns**

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.GetUDLLoadCount(1)
print(result)
```

### GetUDLLoads

**Description**

Returns the UDL loads.

**Parameters**

- `nBeamNo` (int): n beam no.

**Returns**

tuple: `(list[int], list[float], list[float], list[float], list[float])`, one entry per UDL on the beam.
The second list holds the load magnitude, in `kN/m` (Metric base) or `kip/in` (English base); see
[Base Units](/guides/base_units). For example, a `-10` kN/m load reads `-10.0` in a Metric-base model
and `-0.0571016` in an English-base one.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.GetUDLLoads(1)
print(result)
```

### GetUNIMomentCount

**Description**

Returns the UNI moment count.

**Parameters**

- `nBeamNo` (int): n beam no.

**Returns**

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.GetUNIMomentCount(1)
print(result)
```

### GetUNIMoments

**Description**

Returns the UNI moments.

**Parameters**

- `nBeamNo` (int): n beam no.

**Returns**

list: A list of values.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.GetUNIMoments(1)
print(result)
```

## Transform

### MergeLoadsOnBeam

**Description**

Merges the loads on beam.

**Parameters**

- `varBeamToKeep` (int): var beam to keep.
- `varBeamToMerge` (int): var beam to merge.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.MergeLoadsOnBeam(1, 1)
print(result)
```

### SplitLoadsOnBeam

**Description**

Splits the loads on beam.

**Parameters**

- `varBeamOld` (int): var beam old.
- `varBeamNew` (int): var beam new.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.SplitLoadsOnBeam(1, 1)
print(result)
```

## Execute

### BeginLoadMerging

**Description**

Calls the `BeginLoadMerging` function on the OpenStaad `ops` session.

**Parameters**

None.

**Returns**

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.BeginLoadMerging()
print(result)
```

### EndLoadMerging

**Description**

Calls the `EndLoadMerging` function on the OpenStaad `ops` session.

**Parameters**

None.

**Returns**

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.EndLoadMerging()
print(result)
```
