wiki:sns:snsscript:surface_loads []

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
~~NOTOC~~
====== Surface Loads Specification ======

===== boolSuccess = objSnSScript.AddFaceVectorLoad(GUID, LoadDescription, FaceIndices, LoadVector, PerFace) =====

This function adds a vector load to the faces specified on the object. Equivalent to a Vector Load in SnS.

^Parameter^Description|
|String GUID|Rhino ID of the object.|
|String LoadDescription|Description of this load. Equivalent to the Description entered in the text box when creating or editing loads in SnS. Should be unique.|
|Array(int) FaceIndices|The indices of the faces on the solid to apply the load to, an array of integers. If only one face is to be loaded, it is not necessary to put the index in an array.|
|Array(double) LoadVector|The vector components of the load, in the form Fx, Fy, Fz. Equivalent to the "Vector Force Components" entry when creating or editing a vector load in SnS.|
|Boolean PerFace|Equivalent to the "Per Face" checkbox when specifying loads in SnS.|
^Return Type^Description|
|Boolean|True if the load was successfully added to the object, False otherwise.|

===== boolSuccess = objSnSScript.AddFaceScalarLoad(GUID, LoadDescription, FaceIndices, LoadValue, PerFace) =====

This function puts a scalar load on the faces specified on the object. Equivalent to a Scalar Load in SnS.

^Parameter^Description|
|String GUID|Rhino ID of the object.|
|String LoadDescription|Description of this load. Equivalent to the Description entered in the text box when creating or editing loads in SnS. Should be unique.|
|Array(int) FaceIndices|The indices of the faces on the solid to apply the load to, an array of integers. If only one face is to be loaded, it is not necessary to put the index in an array.|
|Double LoadValue|The magnitude of the load.|
|Boolean PerFace|Equivalent to the "Per Face" checkbox when specifying loads in SnS.|
^Return Type^Description|
|Boolean|True if the load was successfully added to the object, False otherwise.|

===== boolSuccess = objSnSScript.AddFacePressureLoad(GUID, LoadDescription, FaceIndices, LoadValue) =====

This function puts a pressure load on the faces specified on the object. Equivalent to a Pressure Load in SnS.

^Parameter^Description|
|String GUID|Rhino ID of the object.|
|String LoadDescription|Description of this load. Equivalent to the Description entered in the text box when creating or editing loads in SnS. Should be unique.|
|Array(int) FaceIndices|The indices of the faces on the solid to apply the load to, an array of integers. If only one face is to be loaded, it is not necessary to put the index in an array.|
|Double LoadValue|The magnitude of the load.|
|Boolean PerFace|Equivalent to the "Per Face" checkbox when specifying loads in SnS.|
^Return Type^Description|
|Boolean|True if the load was successfully added to the object, False otherwise.|

===== boolSuccess = objSnSScript.AddFaceHydrostaticLoad(GUID, LoadDescription, FaceIndices, FluidDensity, Origin, Direction) =====

This function puts a hydrostatic load on the faces specified on the object. Equivalent to a Hydrostatic Load in SnS.

^Parameter^Description|
|String GUID|Rhino ID of the object.|
|String LoadDescription|Description of this load. Equivalent to the Description entered in the text box when creating or editing loads in SnS. Should be unique.|
|Array(int) FaceIndices|The indices of the faces on the solid to apply the load to, an array of integers. If only one face is to be loaded, it is not necessary to put the index in an array.|
|Double FluidDensity|The density of the fluid applying the hydrostatic pressure.|
|Array(double) Origin|An array of three floating point numbers, representing a point in space that lies on the surface of the fluid. In SnS this is specified by using the mouse to select a point, but in SnSScript the point must be numerically specified.|
|Array(double) Direction|An array of three floating point numbers, representing a vector that is the direction of increasing fluid depth. In SnS this is specified by using the mouse to select a direction, but in SnSScript the direction must be numerically specified.|
^Return Type^Description|
|Boolean|True if the load was successfully added to the object, False otherwise.|

===== boolSuccess = objSnSScript.AddFaceTorqueLoad(GUID, LoadDescription, FaceIndices, LoadValue, Origin, Direction) =====

This function puts a torque load on the faces specified on the object. Equivalent to a Torque Load in SnS.

^Parameter^Description|
|String GUID|Rhino ID of the object.|
|String LoadDescription|Description of this load. Equivalent to the Description entered in the text box when creating or editing loads in SnS. Should be unique.|
|Array(int) FaceIndices|The indices of the faces on the solid to apply the load to, an array of integers. If only one face is to be loaded, it is not necessary to put the index in an array.|
|Double LoadValue|The torque to apply using the right hand rule.|
|Array(double) Origin|An array of three floating point numbers, representing a point in space that is the origin of the torque axis. In SnS this is specified by using the mouse to select a point, but in SnSScript the point must be numerically specified.|
|Array(double) Direction|An array of three floating point numbers, representing a vector that is the direction of the torque axis. In SnS this is specified by using the mouse to select a direction, but in SnSScript the direction must be numerically specified.|
^Return Type^Description|
|Boolean|True if the load was successfully added to the object, False otherwise.|