# Nodal Loads functions | OpenStaad Python

> Loads applied at nodes — joint forces and moments — plus the seismic definition and its joint, member, floor, and wall weights.

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

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

## Add

### AddNodalLoad

**Description**

Adds the nodal load.

**Parameters**

- `nodeIds` (list): node ids.
- `forceInXDir` (float): force in x dir.
- `forceInYDir` (float): force in y dir.
- `forceInZDir` (float): force in z dir.
- `momentInXDir` (float): moment in x dir.
- `momentInYDir` (float): moment in y dir.
- `momentInZDir` (float): moment in z dir.

**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.AddNodalLoad([1, 2], 1.0, 1.0, 1.0, 1.0, 1.0, 1.0)
print(result)
```

### AddSeismicDefFloorWeight

**Description**

Adds the seismic def floor weight.

**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.AddSeismicDefFloorWeight(1, 1, 1.0, 1, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0)
print(result)
```

### AddSeismicDefinition

**Description**

Adds the seismic definition.

**Parameters**

- `varType` (int): var type.
- `varAccidental` (int): var accidental.

**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.AddSeismicDefinition(1, 1)
print(result)
```

### AddSeismicDefJointWeight

**Description**

Adds the seismic def joint weight.

**Parameters**

- `weight` (float): weight.
- `nodeList` (list): node list.

**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.AddSeismicDefJointWeight(1.0, [1, 2])
print(result)
```

### AddSeismicDefMemberWeight

**Description**

Adds the seismic def member weight.

**Parameters**

- `varSeismicType` (int): var seismic type.
- `loadType` (int): load type.
- `weight` (float): weight.
- `startDist` (float): start dist.
- `endDist` (float): end dist.
- `memberList` (list): member list.

**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.AddSeismicDefMemberWeight(1, 1, 1.0, 1.0, 1.0, [1, 2])
print(result)
```

### AddSeismicDefSelfWeight

**Description**

Adds the seismic def self weight.

**Parameters**

- `varWeightFactor` (float): var weight factor.

**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.AddSeismicDefSelfWeight(1.0)
print(result)
```

### AddSeismicDefWallArea

**Description**

Adds the seismic def wall area.

**Parameters**

- `nTypeNo` (int): n type no.
- `direction` (str): direction.
- `sizeArray` (list): size array.

**Returns**

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

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.AddSeismicDefWallArea(1, "value", [1, 2])
print(result)
```

## Get

### GetNodalLoadCount

**Description**

Returns the nodal load count.

**Parameters**

- `nNodeNo` (int): n node 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.GetNodalLoadCount(1)
print(result)
```

### GetNodalLoadInfo

**Description**

Returns the nodal load info.

**Parameters**

- `loadIndex` (int): load index.

**Returns**

list: A list of numbers (floats).

**Example**

```python
from openstaad import ops

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

### GetNodalLoads

**Description**

Returns the nodal loads.

**Parameters**

- `nNodeNo` (int): n node no.

**Returns**

tuple: A tuple of `list[float]` values, one per output slot.

**Example**

```python
from openstaad import ops

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

## Set/Assign

### ModifySeismicDefinitionParams

**Description**

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

**Parameters**

- `varParamName` (str): var param name.
- `varValue` (float): var value.

**Returns**

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

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.ModifySeismicDefinitionParams("value", 1.0)
print(result)
```