Class: Convection

Defines a Convection.

Implemented types

Methods

Name Description
Activate() Activate the current object.
AddComment() Creates a new child Comment.
AddFigure() Creates a new child Figure.
AddImage(String) Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the image will be a screen capture of the Geometry window.
CopyTo(DataModelObject) Copies all visible properties from this object to another.
CreateParameter(String) Creates a new parameter for a Property.
Delete() Run the Delete action.
Duplicate() Creates a copy of the current DataModelObject.
GetActivateAtLoadStep(UInt32) Gets whether the convection is active at the specified load step.
GetChildren(Boolean, IList<ChildrenType>)
GetComponentActivateAtLoadStep(String, UInt32)
GetParameter(String) Gets the parameter corresponding to the given property.
GetPath() Gets the path of the object.
GroupAllSimilarChildren() Run the GroupAllSimilarChildren action.
GroupSimilarObjects() Run the GroupSimilarObjects action.
PromoteToNamedSelection() Run the PromoteToNamedSelection action.
PropertyByAPIName(String) Get a property by its API name. If multiple properties have the same API Name, only the first property with that name will be returned.
PropertyByName(String) Get a property by its unique name.
RemoveParameter(String) Removes the parameter from the parameter set corresponding to the given property.
SetActivateAtLoadStep(UInt32, Boolean) Sets whether the convection is active at the specified load step.
SetComponentActivateAtLoadStep(String, UInt32, Boolean)

Properties

Name Description
AmbientTemperature Property used to get and set the ambient temperature data The setter allows the use of a table object, an expression contained in a string or a quantity object as a data source. Depending on the representation type, the getter return type is a field object or an object which type depends on the source of the ambient temperature data: - On table assignment mode, it returns the source table object. - On function mode, it returns a string containing the expression evaluated to obtain the data. - On constant mode, it returns a quantity object containg the value and the units currently assigned to the ambient temperature. - On tabular mode, it returns a tabularDataTable object.
AmbientTemperatureCoordinateSystem The coordinate system id used currently to determinine the position of the points of the ambient temperature variable
CoefficientType Gets or sets the CoefficientType.
Comments Gets the list of associated comments.
ConvectionCoefficientCoordinateSystem The coordinate system id used currently to determinine the position of the points of the convection coefficient variable
ConvectionMatrix Gets or sets the ConvectionMatrix.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
DisplayConnectionLines Gets or sets the DisplayConnectionLines.
EditDataFor Gets or sets the EditDataFor.
ElementAPDLName Gets or Sets the ElementAPDLName which stores the element type number of the convection load. This you can reference and use in Command Snippets.
Figures Gets the list of associated figures.
FilmCoefficient Property used to get and set the film coefficient data The setter allows the use of a table object, an expression contained in a string or a quantity object as a data source. Depending on the representation type, the getter return type is a field object or an object which type depends on the source of the film coefficient data: - On table assignment mode, it returns the source table object. - On function mode, it returns a string containing the expression evaluated to obtain the data. - On constant mode, it returns a quantity object containg the value and the units currently assigned to the film coefficient. - On tabular mode, it returns a tabularDataTable object.
FluidFlowSelection Gets or sets the FluidFlowSelection.
GraphControlsXAxis Gets or sets the GraphControlsXAxis.
HasFluidFlow Gets or sets the HasFluidFlow.
Images Gets the list of associated images.
IndependentVariable Gets or sets the IndependentVariable.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
Name Gets the name of the object.
NumberOfSegments Gets or sets the NumberOfSegments.
ObjectId Gets the internal id of the object.
ObjectTags Gets an IEnumerable object of the tags that 'this' is a part of.
Parent Gets the parent object.
Properties Gets the list of properties for this object.
RangeMaximum Gets or sets the RangeMaximum.
RangeMinimum Gets or sets the RangeMinimum.
ReadOnly Gets or sets the ReadOnly.
SharedRefBody Gets or sets the SharedRefBody.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.
XYZFunctionCoordinateSystem Gets or sets the XYZFunctionCoordinateSystem.