## On this page

  

 

 # Class EFForceAPI

 Last update: 09.03.2026 

<a id="VM_API_Pre_EasyFlex_EFForceAPI"></a>

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 ← [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&lt;T&gt;(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkedObjects__1_System_Object_VM_Models_Pre_LinkPropertyType_)

## Methods

### <a id="VM_API_Pre_EasyFlex_EFForceAPI_CreateConcentratedLoadFaceWithColor_VM_Managed_DAFUL_SubSystemDocument_VM_API_Pre_Obj_System_Collections_Generic_IEnumerable_System_Drawing_Color__System_Nullable_VM_Vector__System_String_System_String_"></a> CreateConcentratedLoadFaceWithColor(SubSystemDocument, Obj, IEnumerable&lt;Color&gt;, 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](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/Data/VMDFBase/SubSystemDocument.cs)

The  to create the concentrated load.

`body` [Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)

The body of the concentrated load

`colors` IEnumerable&lt;Color&gt;

The colors of the concentrated load.

`direction` Vector?

The direction of the concentrated load.

`force` string

The force of the concentrated load.

`name` string

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

#### Returns

[Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)

the new  object created by this API.

#### Exceptions

ArgumentNullException

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

ArgumentException

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

ArgumentException

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

### <a id="VM_API_Pre_EasyFlex_EFForceAPI_CreateConcentratedLoadFaceWithFaces_VM_Managed_DAFUL_SubSystemDocument_System_Collections_Generic_IEnumerable_VM_API_Pre_Obj__System_Nullable_VM_Vector__System_String_System_String_"></a> 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](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/Data/VMDFBase/SubSystemDocument.cs)

The  to create the concentrated load.

`baseGeometry` IEnumerable&lt;[Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)&gt;

The base geometry of the concentrated load

`direction` Vector?

The direction of the concentrated load.

`force` string

The force of the concentrated load.

`name` string

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

#### Returns

[Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)

the new  object created by this API.

#### Exceptions

ArgumentNullException

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

ArgumentException

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

ArgumentException

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

### <a id="VM_API_Pre_EasyFlex_EFForceAPI_CreateConcentratedLoadFaceWithFaceset_VM_Managed_DAFUL_SubSystemDocument_VM_API_Pre_Obj_System_Nullable_VM_Vector__System_String_System_String_"></a> 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](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/Data/VMDFBase/SubSystemDocument.cs)

The  to create the concentrated load.

`baseGeometry` [Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)

The base geometry of the concentrated load

`direction` Vector?

The direction of the concentrated load.

`force` string

The force of the concentrated load.

`name` string

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

#### Returns

[Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)

the new  object created by this API.

#### Exceptions

ArgumentNullException

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

ArgumentException

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

ArgumentException

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

### <a id="VM_API_Pre_EasyFlex_EFForceAPI_CreateConcentratedLoadRange_VM_Managed_DAFUL_SubSystemDocument_VM_API_Pre_Obj_VM_Vector_VM_Vector_System_Nullable_VM_Models_Pre_ExpressionValueVariable__System_Nullable_VM_Vector__System_String_System_String_"></a> 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](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/Data/VMDFBase/SubSystemDocument.cs)

The  to create the concentrated load.

`body` [Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)

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](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/Pre/Data/VM.Models.Pre/Models/ExpressionValueVariable.cs)?

The radius of the concentrated load.

`direction` Vector?

The direction of the concentrated load.

`force` string

The force of the concentrated load.

`name` string

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

#### Returns

[Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)

the new  object created by this API.

#### Exceptions

ArgumentNullException

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

ArgumentException

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

ArgumentException

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

ArgumentOutOfRangeException

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

### <a id="VM_API_Pre_EasyFlex_EFForceAPI_CreatePressureLoadWithColor_VM_Managed_DAFUL_SubSystemDocument_VM_API_Pre_Obj_System_Collections_Generic_IEnumerable_System_Drawing_Color__System_Boolean_System_String_System_String_"></a> 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](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/Data/VMDFBase/SubSystemDocument.cs)

The  to create the pressure load.

`body` [Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)

The body of the pressure load

`colors` IEnumerable&lt;Color&gt;

The colors of the pressure load.

`isNormal` bool

The flag of normal of the pressure load.

`normal` string

The normal of the pressure load.

`name` string

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

#### Returns

[Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)

the new  object created by this API.

#### Exceptions

ArgumentNullException

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

ArgumentException

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

ArgumentException

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

### <a id="VM_API_Pre_EasyFlex_EFForceAPI_CreatePressureLoadWithFaces_VM_Managed_DAFUL_SubSystemDocument_System_Collections_Generic_IEnumerable_VM_API_Pre_Obj__System_Boolean_System_String_System_String_"></a> 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](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/Data/VMDFBase/SubSystemDocument.cs)

The  to create the pressure load.

`baseGeometry` IEnumerable&lt;[Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)&gt;

The base geometry of the pressure load

`isNormal` bool

The flag of normal of the pressure load.

`normal` string

The normal of the pressure load.

`name` string

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

#### Returns

[Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)

the new  object created by this API.

#### Exceptions

ArgumentNullException

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

ArgumentException

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

### <a id="VM_API_Pre_EasyFlex_EFForceAPI_CreatePressureLoadWithFaceset_VM_Managed_DAFUL_SubSystemDocument_VM_API_Pre_Obj_System_Boolean_System_String_System_String_"></a> 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](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/Data/VMDFBase/SubSystemDocument.cs)

The  to create the pressure load.

`baseGeometry` [Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)

The base geometry of the pressure load

`isNormal` bool

The flag of normal of the pressure load.

`normal` string

The normal of the pressure load.

`name` string

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

#### Returns

[Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)

the new  object created by this API.

#### Exceptions

ArgumentNullException

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

ArgumentException

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