Class BeamBodyAPI

Namespace: VM.API.Pre.FE
Assembly: VM.API.Pre.FE.dll

This class implements API to create new .

public static class BeamBodyAPI

Inheritance

object ← BeamBodyAPI

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)

Methods

CreateBeamNodalBody(SubSystemDocument, string, string, Vector, Vector, Vector, ExpressionValueVariable, ExpressionValueVariable, ExpressionValueVariable)

Create Beam FE Body for Beam Contact

[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "strNewMeshFilePath" })]
[GreaterThanZero(new string[] { "radius" })]
[GreaterThanOrEqualToSomeValue("numOfBeamNodes", 3)]
public static Obj CreateBeamNodalBody(this SubSystemDocument document, string strNewMeshFilePath, string strFEBodyName, Vector startPoint, Vector endPoint, Vector yDirection, ExpressionValueVariable radius, ExpressionValueVariable numberOfHexElementPerSegment, ExpressionValueVariable numOfBeamNodes)

Parameters

document SubSystemDocument

The to create beam FE body.

strNewMeshFilePath string

The path to new .dfmesh file.

strFEBodyName string

The name of the new .

startPoint Vector

The start point of the beam.

endPoint Vector

The end point of the beam.

yDirection Vector

The Y direction vector of the beam.

radius ExpressionValueVariable

The radius of the beam.

numberOfHexElementPerSegment ExpressionValueVariable

The number of hexa elements per segment.

numOfBeamNodes ExpressionValueVariable

The number of beam nodes.

Returns

Obj

the new FE beam body

Exceptions

ArgumentNullException

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

ArgumentException

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

ArgumentOutOfRangeException

Will be thrown if 'radius' value equal to or less than 0.

ArgumentOutOfRangeException

Will be thrown if 'numOfBeamNodes' is less than 3.

ArgumentException

Will be thrown if distance of 'startPoint' and 'endPoint' is less than 1.0e-5.

ArgumentException

Will be thrown if vector of 'endPoint' - 'startPoint' parallel with 'yDirection'.

ArgumentException

Will be thrown if 'numberOfHexElementPerSegment' is less than 8 or an odd number.