## On this page

  

 

 # Class PressureLoadAPI

 Last update: 16.07.2025 

Namespace: [VM.API.Pre.FE](VM.API.Pre.FE.md)  
Assembly: VM.API.Pre.FE.dll

This class implements APIs for BoundaryCondition class.

```csharp
public static class PressureLoadAPI

```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← [PressureLoadAPI](VM.API.Pre.FE.PressureLoadAPI.md)

#### Extension Methods

[LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkProperties_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkPropertiesAndValues_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkedObjects__1_System_Object_VM_Models_Pre_LinkPropertyType_)

## Methods

### CreatePressureLoad(SubSystemDocument, Obj, string, Obj?)

Create  with functions.

```csharp
[MatchTypeObj(new object[] { "function", typeof(Function) })]
public static Obj CreatePressureLoad(this SubSystemDocument document, Obj pressureLoadComponent, string pressureLoadName = "", Obj? function = null)

```

#### Parameters

`document` SubSystemDocument

The document to create the pressure load.

`pressureLoadComponent` Obj

The pressure load component

`pressureLoadName` [string](https://learn.microsoft.com/dotnet/api/system.string)

The name of the pressure load. If empty, default name starts with 'PLoad\_' will be generated and used.

`function` Obj?

The name of the function.

#### Returns

Obj

The new  object that is created by this API.

#### Exceptions

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

Will be thrown if 'document' or 'pressureLoadComponent' arguments are empty.

[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)

Will be thrown if 'function' argument is not empty and type of 'function' is not .

### CreatePressureLoad(SubSystemDocument, Obj, Obj, string)

Create  with user-subrooutine.

```csharp
[NotNullObj(new string[] { "usub" })]
[MatchTypeObj(new object[] { "usub", typeof(UserSubroutine) })]
public static Obj CreatePressureLoad(this SubSystemDocument document, Obj pressureLoadComponent, Obj usub, string pressureLoadName = "")

```

#### Parameters

`document` SubSystemDocument

The document to create the pressure load.

`pressureLoadComponent` Obj

The pressure load component

`usub` Obj

The name of the user-subrooutine.

`pressureLoadName` [string](https://learn.microsoft.com/dotnet/api/system.string)

The name of the pressure load. If empty, default name starts with 'PLoad\_' will be generated and used.

#### Returns

Obj

The new  object that is created by this API.

#### Exceptions

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

Will be thrown if 'document' or 'pressureLoadComponent' arguments are empty.

[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)

Will be thrown if 'usub' argument is not empty and type of 'usub' is not .