Radiation
Last update: 14.01.2025
Radiation
class Ansys.ACT.Automation.Mechanical.BoundaryConditions.Radiation
Bases: object
Defines a Radiation.
Overview
Methods
Name | Description |
---|---|
Activate |
Activate the current object. |
AddComment |
Creates a new child Comment. |
AddFigure |
Creates a new child Figure. |
AddImage |
Creates a new child Image. |
CopyTo |
Copies all visible properties from this object to another. |
CreateParameter |
Creates a new parameter for a Property. |
Delete |
Run the Delete action. |
Duplicate |
Creates a copy of the current DataModelObject. |
GetActivateAtLoadStep |
Gets whether the radiation is active at the specified load step. |
GetChildren |
Gets the list of children, filtered by type. |
GetComponentActivateAtLoadStep |
GetComponentActivateAtLoadStep method. |
GetParameter |
Gets the parameter corresponding to the given property. |
GroupAllSimilarChildren |
Run the GroupAllSimilarChildren action. |
GroupSimilarObjects |
Run the GroupSimilarObjects action. |
PromoteToNamedSelection |
Run the PromoteToNamedSelection action. |
PropertyByAPIName |
Get a property by its API name. |
PropertyByName |
Get a property by its unique name. |
RemoveParameter |
Removes the parameter from the parameter set corresponding to the given property. |
SetActivateAtLoadStep |
Sets whether the radiation is active at the specified load step. |
SetComponentActivateAtLoadStep |
SetComponentActivateAtLoadStep method. |
Properties
Name | Description |
---|---|
AmbientTemperature |
Gets the AmbientTemperature. |
Children |
Gets the list of children. |
Comments |
Gets the list of associated comments. |
Correlation |
Gets or sets the Correlation. |
DataModelObjectCategory |
Gets the current DataModelObject’s category. |
EditDataFor |
Gets or sets the EditDataFor. |
Emissivity |
Gets or sets the Emissivity. |
Enclosure |
Gets or sets the Enclosure. |
EnclosureType |
Gets or sets the EnclosureType. |
Figures |
Gets the list of associated figures. |
Images |
Gets the list of associated images. |
InternalObject |
Gets the internal object. For advanced usage only. |
Location |
Gets or sets the Location. |
NumberOfSegments |
Gets or sets the NumberOfSegments. |
Properties |
Gets the list of properties for this object. |
ReadOnly |
Gets or sets the ReadOnly. |
SharedRefBody |
Gets or sets the SharedRefBody. |
ShellFace |
Gets or sets the ShellFace. |
Suppressed |
Gets or sets the Suppressed. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
Property detail
property Radiation.AmbientTemperature : Ansys.ACT.Mechanical.Fields.Field | None
Gets the AmbientTemperature.
property Radiation.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property Radiation.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property Radiation.Correlation : Ansys.Mechanical.DataModel.Enums.RadiationType | None
Gets or sets the Correlation.
property Radiation.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property Radiation.EditDataFor : Ansys.Mechanical.DataModel.Enums.ConvectionTableSelection | None
Gets or sets the EditDataFor.
property Radiation.Emissivity : Ansys.ACT.Mechanical.Fields.Field | None
Gets or sets the Emissivity.
property Radiation.Enclosure : int | None
Gets or sets the Enclosure.
property Radiation.EnclosureType : Ansys.Mechanical.DataModel.Enums.EnclosureType | None
Gets or sets the EnclosureType.
property Radiation.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
property Radiation.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property Radiation.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None
Gets the internal object. For advanced usage only.
property Radiation.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the Location.
property Radiation.NumberOfSegments : int | None
Gets or sets the NumberOfSegments.
property Radiation.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property Radiation.ReadOnly : bool | None
Gets or sets the ReadOnly.
property Radiation.SharedRefBody : Ansys.ACT.Automation.Mechanical.Body | None
Gets or sets the SharedRefBody.
property Radiation.ShellFace : Ansys.Mechanical.DataModel.Enums.ShellFaceType | None
Gets or sets the ShellFace.
property Radiation.Suppressed : bool | None
Gets or sets the Suppressed.
property Radiation.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
Radiation.Activate()
Activate the current object.
Radiation.AddComment()
Creates a new child Comment.
Radiation.AddFigure()
Creates a new child Figure.
Radiation.AddImage(filePath: str)
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.
Radiation.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
Radiation.CreateParameter(propName: str)
Creates a new parameter for a Property.
Radiation.Delete()
Run the Delete action.
Radiation.Duplicate()
Creates a copy of the current DataModelObject.
Radiation.GetActivateAtLoadStep(stepNumber: int)
Gets whether the radiation is active at the specified load step.
Radiation.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
Radiation.GetComponentActivateAtLoadStep(component: str, stepNumber: int)
GetComponentActivateAtLoadStep method.
Radiation.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
Radiation.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
Radiation.GroupSimilarObjects()
Run the GroupSimilarObjects action.
Radiation.PromoteToNamedSelection()
Run the PromoteToNamedSelection action.
Radiation.PropertyByAPIName(name: str)
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.
Radiation.PropertyByName(name: str)
Get a property by its unique name.
Radiation.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.
Radiation.SetActivateAtLoadStep(stepNumber: int, bActive: bool)
Sets whether the radiation is active at the specified load step.
Radiation.SetComponentActivateAtLoadStep(component: str, stepNumber: int, bActive: bool)
SetComponentActivateAtLoadStep method.