## On this page

  

 

 # Class BoundaryConditionAPI

 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  class.

```csharp
public static class BoundaryConditionAPI

```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← [BoundaryConditionAPI](VM.API.Pre.FE.BoundaryConditionAPI.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

### CreateBoundaryCondition(SubSystemDocument, Obj, string, Obj?, bool, bool, bool, bool, bool, bool)

Create .

```csharp
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "boundaryConditionComponent" })]
[MatchTypeObj(new object[] { "boundaryConditionComponent", typeof(IGeometricalComponent) })]
public static Obj CreateBoundaryCondition(this SubSystemDocument document, Obj boundaryConditionComponent, string boundaryConditionName = "", Obj? referenceMarker = null, bool translationalX = true, bool translationalY = true, bool translationalZ = true, bool rotationalX = true, bool rotationalY = true, bool rotationalZ = true)

```

#### Parameters

`document` SubSystemDocument

The document to create the boundary condition.

`boundaryConditionComponent` Obj

The boundary condition component

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

The name of the boundary condition. If empty, default name starts with 'BC\_' will be generated and used.

`referenceMarker` Obj?

The reference marker.

`translationalX` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

The flag whether using translational X.

`translationalY` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

The flag whether using translational Y.

`translationalZ` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

The flag whether using translational Z.

`rotationalX` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

The flag whether using rotational X.

`rotationalY` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

The flag whether using rotational Y.

`rotationalZ` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

The flag whether using rotational Z.

#### 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 'boundaryConditionComponent' arguments are empty.

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

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