M

BoundaryConditions.CreateAreaBoundaryConditions

Description:
Creates a new custom area boundary conditions within the project.

Overloads (2):

CreateAreaBoundaryConditions

CreateAreaBoundaryConditions(Document,ElementId,IList[CurveLoop],TranslationRotationValue,Double,TranslationRotationValue,Double,TranslationRotationValue,Double)

CreateAreaBoundaryConditions(Document,Reference,TranslationRotationValue,Double,TranslationRotationValue,Double,TranslationRotationValue,Double)

public static BoundaryConditions CreateAreaBoundaryConditions(
	Document doc,
	ElementId hostElemId,
	IList<CurveLoop> loops,
	TranslationRotationValue X_Translation,
	double X_TranslationSpringModulus,
	TranslationRotationValue Y_Translation,
	double Y_TranslationSpringModulus,
	TranslationRotationValue Z_Translation,
	double Z_TranslationSpringModulus
)

Public Shared Function CreateAreaBoundaryConditions ( 
	doc As Document,
	hostElemId As ElementId,
	loops As IList(Of CurveLoop),
	X_Translation As TranslationRotationValue,
	X_TranslationSpringModulus As Double,
	Y_Translation As TranslationRotationValue,
	Y_TranslationSpringModulus As Double,
	Z_Translation As TranslationRotationValue,
	Z_TranslationSpringModulus As Double
) As BoundaryConditions

public:
static BoundaryConditions^ CreateAreaBoundaryConditions(
	Document^ doc, 
	ElementId^ hostElemId, 
	IList<CurveLoop^>^ loops, 
	TranslationRotationValue X_Translation, 
	double X_TranslationSpringModulus, 
	TranslationRotationValue Y_Translation, 
	double Y_TranslationSpringModulus, 
	TranslationRotationValue Z_Translation, 
	double Z_TranslationSpringModulus
)

static member CreateAreaBoundaryConditions : 
        doc : Document * 
        hostElemId : ElementId * 
        loops : IList<CurveLoop> * 
        X_Translation : TranslationRotationValue * 
        X_TranslationSpringModulus : float * 
        Y_Translation : TranslationRotationValue * 
        Y_TranslationSpringModulus : float * 
        Z_Translation : TranslationRotationValue * 
        Z_TranslationSpringModulus : float -> BoundaryConditions

Document

doc

The document in which to create the boundary conditions.
ElementId

hostElemId

The AnalyticalElement host element for the area boundary conditions.
IList<CurveLoop>

loops

The loops that define geometry of the area boundary conditions. The curve loop collection should contain only closed loops.
TranslationRotationValue

X_Translation

A value indicating the X axis translation option.
Double

X_TranslationSpringModulus

Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
TranslationRotationValue

Y_Translation

A value indicating the Y axis translation option.
Double

Y_TranslationSpringModulus

Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
TranslationRotationValue

Z_Translation

A value indicating the Z axis translation option.
Double

Z_TranslationSpringModulus

Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".

Return Value BoundaryConditions If successful, returns the newly created boundary conditions with the BoundaryConditionsType = 2 - "Area". Otherwise it returns .

ArgumentException

One of the following requirements is not satisfied : - curve loops loops are not planar - curve loops loops are self-intersecting - curve loops loops contains zero length curves -or- hostElemId is not a valid host for area boundary conditions. -or- Area boundary conditions already exist on the selected hostElemId.
ArgumentNullException

A non-optional argument was null
ArgumentOutOfRangeException

A value passed for an enumeration argument is not a member of that enumeration