## On this page

  

 

 # Class EFForceAPI

 Last update: 16.07.2025 

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

This class implements APIs for  and  class.

```csharp
public static class EFForceAPI

```

#### Inheritance

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

### CreateConcentratedLoadFaceWithColor(SubSystemDocument, Obj, IEnumerable<Color>, Vector?, string, string)

Create  with colors.

```csharp
[NotNull(new string[] { "subSystemDocument", "colors" })]
[NotNullObj(new string[] { "body" })]
[MatchTypeObj(new object[] { "body", typeof(SolidBody) })]
public static Obj CreateConcentratedLoadFaceWithColor(this SubSystemDocument subSystemDocument, Obj body, IEnumerable<Color> colors, Vector? direction = null, string force = "1.0", string name = "")

```

#### Parameters

`subSystemDocument` SubSystemDocument

The  to create the concentrated load.

`body` Obj

The body of the concentrated load

`colors` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1)&lt;[Color](https://learn.microsoft.com/dotnet/api/system.drawing.color)&gt;

The colors of the concentrated load.

`direction` Vector?

The direction of the concentrated load.

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

The force of the concentrated load.

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

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

#### Returns

Obj

the new  object created by this API.

#### Exceptions

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

Will be thrown if 'subSystemDocument', 'body', 'colors' argument is null.

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

Will be thrown if the type of 'body' is not .

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

Will be thrown if the magnitude of 'direction' is 0.

### CreateConcentratedLoadFaceWithFaces(SubSystemDocument, IEnumerable&lt;Obj&gt;, Vector?, string, string)

Create  with faces.

```csharp
[NotNull(new string[] { "subSystemDocument", "baseGeometry" })]
public static Obj CreateConcentratedLoadFaceWithFaces(this SubSystemDocument subSystemDocument, IEnumerable<Obj> baseGeometry, Vector? direction = null, string force = "1.0", string name = "")

```

#### Parameters

`subSystemDocument` SubSystemDocument

The  to create the concentrated load.

`baseGeometry` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1)&lt;Obj&gt;

The base geometry of the concentrated load

`direction` Vector?

The direction of the concentrated load.

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

The force of the concentrated load.

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

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

#### Returns

Obj

the new  object created by this API.

#### Exceptions

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

Will be thrown if 'subSystemDocument', 'baseGeometry' argument is null.

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

Will be thrown if the type of 'baseGeometry' is not .

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

Will be thrown if the magnitude of 'direction' is 0.

### CreateConcentratedLoadFaceWithFaceset(SubSystemDocument, Obj, Vector?, string, string)

Create  with faceset.

```csharp
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseGeometry" })]
[MatchTypeObj(new object[] { "baseGeometry", typeof(IContactableRigid3D) })]
public static Obj CreateConcentratedLoadFaceWithFaceset(this SubSystemDocument subSystemDocument, Obj baseGeometry, Vector? direction = null, string force = "1.0", string name = "")

```

#### Parameters

`subSystemDocument` SubSystemDocument

The  to create the concentrated load.

`baseGeometry` Obj

The base geometry of the concentrated load

`direction` Vector?

The direction of the concentrated load.

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

The force of the concentrated load.

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

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

#### Returns

Obj

the new  object created by this API.

#### Exceptions

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

Will be thrown if 'subSystemDocument', 'baseGeometry' argument is null.

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

Will be thrown if the type of 'baseGeometry' is not .

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

Will be thrown if the magnitude of 'direction' is 0.

### CreateConcentratedLoadRange(SubSystemDocument, Obj, Vector, Vector, ExpressionValueVariable?, Vector?, string, string)

Create  with range.

```csharp
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "body" })]
[NotZeroMagnitude(new string[] { "normalDirectionOfRange" })]
public static Obj CreateConcentratedLoadRange(this SubSystemDocument subSystemDocument, Obj body, Vector point, Vector normalDirectionOfRange, ExpressionValueVariable? radius = null, Vector? direction = null, string force = "1.0", string name = "")

```

#### Parameters

`subSystemDocument` SubSystemDocument

The  to create the concentrated load.

`body` Obj

The body of the concentrated load

`point` Vector

The point of the concentrated load.

`normalDirectionOfRange` Vector

The normal direction of the concentrated load.

`radius` ExpressionValueVariable?

The radius of the concentrated load.

`direction` Vector?

The direction of the concentrated load.

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

The force of the concentrated load.

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

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

#### Returns

Obj

the new  object created by this API.

#### Exceptions

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

Will be thrown if 'subSystemDocument', 'body' argument is null.

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

Will be thrown if the type of 'body' is not  and .

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

Will be thrown if the magnitude of 'normalDirectionOfRange' is 0.

[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)

Will be thrown if the magnitude of 'direction' is 0 or if the 'radius' value is equal to or less than 0.

### CreatePressureLoadWithColor(SubSystemDocument, Obj, IEnumerable&lt;Color&gt;, bool, string, string)

Create  with colors.

```csharp
[NotNull(new string[] { "subSystemDocument", "colors" })]
[NotNullObj(new string[] { "body" })]
[MatchTypeObj(new object[] { "body", typeof(SolidBody) })]
public static Obj CreatePressureLoadWithColor(this SubSystemDocument subSystemDocument, Obj body, IEnumerable<Color> colors, bool isNormal = true, string normal = "1.0", string name = "")

```

#### Parameters

`subSystemDocument` SubSystemDocument

The  to create the pressure load.

`body` Obj

The body of the pressure load

`colors` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1)&lt;[Color](https://learn.microsoft.com/dotnet/api/system.drawing.color)&gt;

The colors of the pressure load.

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

The flag of normal of the pressure load.

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

The normal of the pressure load.

`name` [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 created by this API.

#### Exceptions

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

Will be thrown if 'subSystemDocument', 'body', 'colors' argument is null.

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

Will be thrown if the type of 'body' is not .

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

Will be thrown if the magnitude of 'direction' is 0.

### CreatePressureLoadWithFaces(SubSystemDocument, IEnumerable&lt;Obj&gt;, bool, string, string)

Create  with faces.

```csharp
[NotNull(new string[] { "subSystemDocument", "baseGeometry" })]
public static Obj CreatePressureLoadWithFaces(this SubSystemDocument subSystemDocument, IEnumerable<Obj> baseGeometry, bool isNormal = true, string normal = "1.0", string name = "")

```

#### Parameters

`subSystemDocument` SubSystemDocument

The  to create the pressure load.

`baseGeometry` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1)&lt;Obj&gt;

The base geometry of the pressure load

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

The flag of normal of the pressure load.

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

The normal of the pressure load.

`name` [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 created by this API.

#### Exceptions

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

Will be thrown if 'subSystemDocument', 'baseGeometry' argument is null.

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

Will be thrown if the type of 'baseGeometry' is not .

### CreatePressureLoadWithFaceset(SubSystemDocument, Obj, bool, string, string)

Create  with faceset.

```csharp
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseGeometry" })]
[MatchTypeObj(new object[] { "baseGeometry", typeof(IContactableRigid3D) })]
public static Obj CreatePressureLoadWithFaceset(this SubSystemDocument subSystemDocument, Obj baseGeometry, bool isNormal = true, string normal = "1.0", string name = "")

```

#### Parameters

`subSystemDocument` SubSystemDocument

The  to create the pressure load.

`baseGeometry` Obj

The base geometry of the pressure load

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

The flag of normal of the pressure load.

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

The normal of the pressure load.

`name` [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 created by this API.

#### Exceptions

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

Will be thrown if 'subSystemDocument', 'baseGeometry' argument is null.

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

Will be thrown if the type of 'baseGeometry' is not .