SourceSurfaceThermicBuilder Class Reference
Last update: 17.07.2025Represents a Thermic Surface Source Builder. More...
Static Public Attributes | |
| str | CosN = property(fget=__GetCosN, fset=__SetCosN) |
| Gets or sets the N value for Cos distribution. | |
| str | EmittanceFilePath = property(fget=__GetEmittanceFilePath, fset=__SetEmittanceFilePath) |
| Gets or sets the emittance file. | |
| str | EmittanceOrigin = property(fget=__GetEmittanceOrigin, fset=__SetEmittanceOrigin) |
| Gets or sets the emittance origin Point. | |
| str | EmittanceType = property(fget=__GetEmittanceType, fset=__SetEmittanceType) |
| Gets or sets the emittance type. | |
| str | EmittanceXDirection = property(fget=__GetEmittanceXDirection, fset=__SetEmittanceXDirection) |
| Gets or sets the emittance X direction. | |
| str | EmittanceXDirectionReversed = property(fget=__GetEmittanceXDirectionReversed, fset=__SetEmittanceXDirectionReversed) |
| Gets or sets the property to reverse the emittance of X direction. | |
| str | EmittanceYDirection = property(fget=__GetEmittanceYDirection, fset=__SetEmittanceYDirection) |
| Gets or sets the emittance Y direction. | |
| str | EmittanceYDirectionReversed = property(fget=__GetEmittanceYDirectionReversed, fset=__SetEmittanceYDirectionReversed) |
| Gets or sets the property to reverse the emittance of Y direction. | |
| str | EnableAutomaticUpdate = property(fget=__GetEnableAutomaticUpdate, fset=__SetEnableAutomaticUpdate) |
| Gets or sets the property to enable/disable the automatic update. | |
| str | Flux = property(fget=__GetFlux) |
| Gets the flux. | |
| str | FluxUnit = property(fget=__GetFluxUnit, fset=__SetFluxUnit) |
| Gets or sets the flux unit. | |
| str | IntensityType = property(fget=__GetIntensityType, fset=__SetIntensityType) |
| Gets or sets the intensity diagram. | |
| str | NumberOfRays = property(fget=__GetNumberOfRays, fset=__SetNumberOfRays) |
| Gets or sets the number of rays. | |
| str | PreviewMode = property(fget=__GetPreviewMode, fset=__SetPreviewMode) |
| Gets or sets the preview mode. | |
| str | RayLength = property(fget=__GetRayLength, fset=__SetRayLength) |
| Gets or sets the ray length. | |
| str | SOPLibraryFilePath = property(fget=__GetSOPLibraryFilePath, fset=__SetSOPLibraryFilePath) |
| Gets or sets the surface optical properties library file. | |
| str | SOPParametersFilePath = property(fget=__GetSOPParametersFilePath, fset=__SetSOPParametersFilePath) |
| Gets or sets the surface optical properties parameters file. | |
| str | SOPPluginFilePath = property(fget=__GetSOPPluginFilePath, fset=__SetSOPPluginFilePath) |
| Gets or sets the surface optical properties plug-in file. | |
| str | SOPReflectance = property(fget=__GetSOPReflectance, fset=__SetSOPReflectance) |
| Gets or sets the surface optical properties reflectance. | |
| str | SOPType = property(fget=__GetSOPType, fset=__SetSOPType) |
| Gets or sets the surface optical properties. | |
| str | SourceSurfaceEmissiveFaces = property(fget=__GetSourceSurfaceEmissiveFaces) |
| Returns the interface to edit the emissive faces of the source. | |
| str | Temperature = property(fget=__GetTemperature, fset=__SetTemperature) |
| Gets or sets the temperature. | |
 Static Public Attributes inherited from FeatureBuilder | |
| str | Feature = property(fget=__GetFeature) |
| Returns the feature being edited, or the created feature if the builder is being used in creation mode. | |
| str | FullName = property(fget=__GetFullName) |
| Gets the full name of the feature being edited. | |
| str | Name = property(fget=__GetName, fset=__SetName) |
| Gets or sets the name of the feature being edited. | |
| str | NameWithContext = property(fget=__GetNameWithContext) |
| Gets the name with context of the feature being edited. | |
Additional Inherited Members | |
| Public Member Functions inherited from FeatureBuilder | |
| 'None' | Commit (self) |
| Commits any edits that have been applied to the builder. | |
| 'None' | ShowResult (self) |
| Updates the feature to reflect the result of an edit to the feature for all builders that support showing results. | |
Detailed Description
Represents a Thermic Surface Source Builder.
The Thermic Surface Source Builder creates or edits Thermic Surface Source features.
To create a new instance of this class, use FeatureCollection.CreateSourceSurfaceThermicBuilder.
A thermic surface can define a source for which the total flux and the spectrum are defined by the source's temperature and the optical properties of the support geometry. You can define a thermic source on any face of the geometry.
Member Data Documentation
◆ CosN
|
static |
Gets or sets the N value for Cos distribution.
Prerequisite: The IntensityType property must be 1.
Value type: Double.
The default value is 3.0.
◆ EmittanceFilePath
|
static |
Gets or sets the emittance file.
Prerequisite: The EmittanceType property must be 0.
Value type: String.
The default value is an empty string.
◆ EmittanceOrigin
|
static |
Gets or sets the emittance origin Point.
Prerequisite: The EmittanceType property must be 0.
The EmittanceOrigin property takes and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ EmittanceType
|
static |
Gets or sets the emittance type.
The values are:
0 - Temperature Field.
1 - Emissive Faces.
Value type: Integer.
The default value is 1.
◆ EmittanceXDirection
|
static |
Gets or sets the emittance X direction.
Prerequisite: The EmittanceType property must be 0.
The EmittanceXDirection property takes and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ EmittanceXDirectionReversed
|
static |
Gets or sets the property to reverse the emittance of X direction.
Prerequisite: The EmittanceType property must be 0.
True: Reverses the emittance direction X.
False: Does not reverse the emittance direction X.
Value type: Boolean.
The default value is False.
◆ EmittanceYDirection
|
static |
Gets or sets the emittance Y direction.
Prerequisite: The EmittanceType property must be 0.
The EmittanceXDirection property takes and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ EmittanceYDirectionReversed
|
static |
Gets or sets the property to reverse the emittance of Y direction.
Prerequisite: The EmittanceType property must be 0.
True: Reverses the emittance direction Y.
False: Does not reverse the emittance direction Y.
Value type: Boolean.
The default value is False.
◆ EnableAutomaticUpdate
|
static |
Gets or sets the property to enable/disable the automatic update.
True: Enables the automatic update.
False: Disables the automatic update.
Value type: Boolean.
The default value is False.
◆ Flux
|
static |
Gets the flux.
Value type: Double.
The default value is 0.
◆ FluxUnit
|
static |
Gets or sets the flux unit.
The values are:
0 - lumen (lm).
1 - watt (W).
Value type: Integer.
The default value is 0.
◆ IntensityType
|
static |
Gets or sets the intensity diagram.
The intensity diagram of a source describes in which directions is made the emission.
The values are:
0 - Lambertian.
1 - Cos.
Value type: Integer.
The default value is 0.
◆ NumberOfRays
|
static |
Gets or sets the number of rays.
Value type: Integer.
Range: The value must be superior or equal to 0.
The default value is 100.
◆ PreviewMode
|
static |
Gets or sets the preview mode.
The values are:
0 - Meshing.
1 - BoundingBox.
Value type: Integer.
The default value is Meshing (0).
◆ RayLength
|
static |
Gets or sets the ray length.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 75.0 mm.
◆ SOPLibraryFilePath
|
static |
Gets or sets the surface optical properties library file.
Prerequisite: The SOPType property must be 2.
Value type: String.
The default value is an empty string.
◆ SOPParametersFilePath
|
static |
Gets or sets the surface optical properties parameters file.
Prerequisite: The SOPType property must be 3.
Value type: String.
The default value is an empty string.
◆ SOPPluginFilePath
|
static |
Gets or sets the surface optical properties plug-in file.
Prerequisite: The SOPType property must be 3.
Value type: String.
The default value is an empty string.
◆ SOPReflectance
|
static |
Gets or sets the surface optical properties reflectance.
Prerequisite: The SOPType property must be 1.
Value type: Double (in percentage).
Range: [0.0, 100.0].
The default value is 100.0 percent.
◆ SOPType
|
static |
Gets or sets the surface optical properties.
Prerequisite: The EmittanceType property must be 0.
The values are:
1 - Mirror, uses a perfect specular surface and edits the Reflectance value if needed.
2 - Library, with this value the SOPLibraryFile property is available and must be defined.
3 - Plug-in, selects a custom made *.sop plug-in as File and the Parameters file for the plug-in.
Value type: Integer.
The default value is 1.
◆ SourceSurfaceEmissiveFaces
|
static |
Returns the interface to edit the emissive faces of the source.
Prerequisite: The ExitanteType property must be 0.
Value type: SourceSurfaceEmissiveFaces object.
◆ Temperature
|
static |
Gets or sets the temperature.
Prerequisite: The SpectrumType property must be 0.
Value type: Double (in Kelvin).
Range: The value must be superior to 0.0.
The default value is 8000.0 Kelvin.
The documentation for this class was generated from the following file:
- SpeosNX.py
