surface
surface_analysisgroup(top: str, bottom: str) -> System.Collections.Generic.Dictionary
| parameter |
type |
description |
| top
| str
| name of the analysis group for the top surface
|
| bottom
| str
| name of the analysis group for the bottom surface
|
create_rectangle(td: OpenTDv62.ThermalDesktop, data: pandas.Series)
| parameter |
type |
description |
| td |
OpenTDv62.ThermalDesktop |
Thermal Desktop instance |
| data
| pandas.Series
| rectangle parameters in pandas.Series
|
In 'data' (type: pandas.Series), the following parameters are specified.
| keyword |
type |
description |
| Submodel name
| str
| name of the submodel
|
| Start ID
| int
| starting node ID for this element
|
| Breakdown U
| int
| number of divisions in X direction
|
| Breakdown V
| int
| number of divisions in Y direction
|
| Node positions
| str
| 'EDGE' or 'CENTERED'
|
| XMax [mm]
| float
| X side length of the rectangle
|
| YMax [mm]
| float
| Y side length of the rectangle
|
| Thickness [mm]
| float
| thickness of the surface
|
| X [mm]
| float
| X coordinate of the element origin
|
| Y [mm]
| float
| Y coordinate of the element origin
|
| Z [mm]
| float
| Z coordinate of the element origin
|
| rot X [deg]
| float
| X roation angle of the ZYX Euler angles
|
| rot Y [deg]
| float
| Y roation angle of the ZYX Euler angles
|
| rot Z [deg]
| float
| Z roation angle of the ZYX Euler angles
|
| Top optical property
| str
| name of the top side optical property
|
| Bottom optical property
| str
| name of the bottom side optical property
|
| Material
| str
| name of the bulk material
|
| Top analysis group
| str
| name of the top side analysis group
|
| Bottom analysis group
| str
| name of the bottom side analysis group
|
| Color
| int
| color code
|
| Comment
| str
| unique comment within the submodel for specifying the element
|
create_cylinder(td: OpenTDv62.ThermalDesktop, data: pandas.Series)
| parameter |
type |
description |
| td |
OpenTDv62.ThermalDesktop |
Thermal Desktop instance |
| data
| pandas.Series
| rectangle parameters in pandas.Series
|
In 'data' (type: pandas.Series), the following parameters are specified.
| keyword |
type |
description |
| Submodel name
| str
| name of the submodel
|
| Start ID
| int
| starting node ID for this element
|
| Breakdown U
| int
| number of divisions in X direction
|
| Breakdown V
| int
| number of divisions in Y direction
|
| Node positions
| str
| 'EDGE' or 'CENTERED'
|
| Radius [mm]
| float
| radius of the cylinder
|
| Height [mm]
| float
| height of the cylinder
|
| Thickness [mm]
| float
| thickness of the surface
|
| Start angle [deg]
| float
| start angle of the cylinder
|
| End angle [deg]
| float
| end angle of the cylinder
|
| X [mm]
| float
| X coordinate of the element origin
|
| Y [mm]
| float
| Y coordinate of the element origin
|
| Z [mm]
| float
| Z coordinate of the element origin
|
| rot X [deg]
| float
| X roation angle of the ZYX Euler angles
|
| rot Y [deg]
| float
| Y roation angle of the ZYX Euler angles
|
| rot Z [deg]
| float
| Z roation angle of the ZYX Euler angles
|
| Top optical property
| str
| name of the top side optical property
|
| Bottom optical property
| str
| name of the bottom side optical property
|
| Material
| str
| name of the bulk material
|
| Top analysis group
| str
| name of the top side analysis group
|
| Bottom analysis group
| str
| name of the bottom side analysis group
|
| Color
| int
| color code
|
| Comment
| str
| unique comment within the submodel for specifying the element
|
create_disk(td: OpenTDv62.ThermalDesktop, data: pandas.Series)
| parameter |
type |
description |
| td |
OpenTDv62.ThermalDesktop |
Thermal Desktop instance |
| data
| pandas.Series
| rectangle parameters in pandas.Series
|
In 'data' (type: pandas.Series), the following parameters shall be specified.
| keyword |
type |
description |
| Submodel name
| str
| name of the submodel
|
| Start ID
| int
| starting node ID for this element
|
| Breakdown U
| int
| number of divisions in X direction
|
| Breakdown V
| int
| number of divisions in Y direction
|
| Node positions
| str
| 'EDGE' or 'CENTERED'
|
| Max radius [mm]
| float
| max radius of the disk
|
| Min radius [mm]
| float
| min radius of the disk
|
| Thickness [mm]
| float
| thickness of the surface
|
| Start angle [deg]
| float
| start angle of the disk
|
| End angle [deg]
| float
| end angle of the disk
|
| X [mm]
| float
| X coordinate of the element origin
|
| Y [mm]
| float
| Y coordinate of the element origin
|
| Z [mm]
| float
| Z coordinate of the element origin
|
| rot X [deg]
| float
| X roation angle of the ZYX Euler angles
|
| rot Y [deg]
| float
| Y roation angle of the ZYX Euler angles
|
| rot Z [deg]
| float
| Z roation angle of the ZYX Euler angles
|
| Top optical property
| str
| name of the top side optical property
|
| Bottom optical property
| str
| name of the bottom side optical property
|
| Material
| str
| name of the bulk material
|
| Top analysis group
| str
| name of the top side analysis group
|
| Bottom analysis group
| str
| name of the bottom side analysis group
|
| Color
| int
| color code
|
| Comment
| str
| unique comment within the submodel for specifying the element
|
create_cone(td: OpenTDv62.ThermalDesktop, data: pd.Series)
| parameter |
type |
description |
| td |
OpenTDv62.ThermalDesktop |
Thermal Desktop instance |
| data
| pandas.Series
| rectangle parameters in pandas.Series
|
In 'data' (type: pandas.Series), the following parameters shall be specified.
| keyword |
type |
description |
| Submodel name
| str
| name of the submodel
|
| Start ID
| int
| starting node ID for this element
|
| Breakdown U
| int
| number of divisions in X direction
|
| Breakdown V
| int
| number of divisions in Y direction
|
| Node positions
| str
| 'EDGE' or 'CENTERED'
|
| Base radius [mm]
| float
| base radius of the cone
|
| Top radius [mm]
| float
| top radius of the cone
|
| Height [mm]
| float
| height of the cone
|
| Thickness [mm]
| float
| thickness of the surface
|
| Start angle [deg]
| float
| start angle of the cone
|
| End angle [deg]
| float
| end angle of the cone
|
| X [mm]
| float
| X coordinate of the element origin
|
| Y [mm]
| float
| Y coordinate of the element origin
|
| Z [mm]
| float
| Z coordinate of the element origin
|
| rot X [deg]
| float
| X roation angle of the ZYX Euler angles
|
| rot Y [deg]
| float
| Y roation angle of the ZYX Euler angles
|
| rot Z [deg]
| float
| Z roation angle of the ZYX Euler angles
|
| Top optical property
| str
| name of the top side optical property
|
| Bottom optical property
| str
| name of the bottom side optical property
|
| Material
| str
| name of the bulk material
|
| Top analysis group
| str
| name of the top side analysis group
|
| Bottom analysis group
| str
| name of the bottom side analysis group
|
| Color
| int
| color code
|
| Comment
| str
| unique comment within the submodel for specifying the element
|
create_torus(td: OpenTDv62.ThermalDesktop, data: pd.Series)
| parameter |
type |
description |
| td |
OpenTDv62.ThermalDesktop |
Thermal Desktop instance |
| data
| pandas.Series
| rectangle parameters in pandas.Series
|
In 'data' (type: pandas.Series), the following parameters shall be specified.
| keyword |
type |
description |
| Submodel name
| str
| name of the submodel
|
| Start ID
| int
| starting node ID for this element
|
| Breakdown U
| int
| number of divisions in X direction
|
| Breakdown V
| int
| number of divisions in Y direction
|
| Node positions
| str
| 'EDGE' or 'CENTERED'
|
| Large radius [mm]
| float
| large radius of the torus
|
| Small radius [mm]
| float
| small radius of the torus
|
| Thickness [mm]
| float
| thickness of the surface
|
| Start angle large radius [deg]
| float
| start angle of the large radius
|
| End angle large radius [deg]
| float
| end angle of the large radius
|
| Start angle small radius [deg]
| float
| start angle of the small radius
|
| End angle small radius [deg]
| float
| end angle of the small radius
|
| X [mm]
| float
| X coordinate of the element origin
|
| Y [mm]
| float
| Y coordinate of the element origin
|
| Z [mm]
| float
| Z coordinate of the element origin
|
| rot X [deg]
| float
| X roation angle of the ZYX Euler angles
|
| rot Y [deg]
| float
| Y roation angle of the ZYX Euler angles
|
| rot Z [deg]
| float
| Z roation angle of the ZYX Euler angles
|
| Top optical property
| str
| name of the top side optical property
|
| Bottom optical property
| str
| name of the bottom side optical property
|
| Material
| str
| name of the bulk material
|
| Top analysis group
| str
| name of the top side analysis group
|
| Bottom analysis group
| str
| name of the bottom side analysis group
|
| Color
| int
| color code
|
| Comment
| str
| unique comment within the submodel for specifying the element
|
create_scarfedcylinder(td: OpenTDv62.ThermalDesktop, data: pd.Series)
| parameter |
type |
description |
| td |
OpenTDv62.ThermalDesktop |
Thermal Desktop instance |
| data
| pandas.Series
| rectangle parameters in pandas.Series
|
In 'data' (type: pandas.Series), the following parameters shall be specified.
| keyword |
type |
description |
| Submodel name
| str
| name of the submodel
|
| Start ID
| int
| starting node ID for this element
|
| Breakdown U
| int
| number of divisions in X direction
|
| Breakdown V
| int
| number of divisions in Y direction
|
| Node positions
| str
| 'EDGE' or 'CENTERED'
|
| Radius [mm]
| float
| radius of the cylinder
|
| Height [mm]
| float
| height of the cylinder
|
| Thickness [mm]
| float
| thickness of the surface
|
| Start angle [deg]
| float
| start angle of the cylinder
|
| End angle [deg]
| float
| end angle of the cylinder
|
| Scarf angle [deg]
| float
| scarf angle of he cylinder
|
| X [mm]
| float
| X coordinate of the element origin
|
| Y [mm]
| float
| Y coordinate of the element origin
|
| Z [mm]
| float
| Z coordinate of the element origin
|
| rot X [deg]
| float
| X roation angle of the ZYX Euler angles
|
| rot Y [deg]
| float
| Y roation angle of the ZYX Euler angles
|
| rot Z [deg]
| float
| Z roation angle of the ZYX Euler angles
|
| Top optical property
| str
| name of the top side optical property
|
| Bottom optical property
| str
| name of the bottom side optical property
|
| Material
| str
| name of the bulk material
|
| Top analysis group
| str
| name of the top side analysis group
|
| Bottom analysis group
| str
| name of the bottom side analysis group
|
| Color
| int
| color code
|
| Comment
| str
| unique comment within the submodel for specifying the element
|
create_sphere(td: OpenTDv62.ThermalDesktop, data: pandas.Series)
| parameter |
type |
description |
| td |
OpenTDv62.ThermalDesktop |
Thermal Desktop instance |
| data
| pandas.Series
| rectangle parameters in pandas.Series
|
In 'data' (type: pandas.Series), the following parameters are specified.
| keyword |
type |
description |
| Submodel name
| str
| name of the submodel
|
| Start ID
| int
| starting node ID for this element
|
| Breakdown U
| int
| number of divisions in X direction
|
| Breakdown V
| int
| number of divisions in Y direction
|
| Node positions
| str
| 'EDGE' or 'CENTERED'
|
| Radius [mm]
| float
| radius of the cylinder
|
| Min height [mm]
| float
| Min Z coordinate of the sphere in the local coordinates
|
| Max height [mm]
| float
| Max Z coordinate of the sphere in the local coordinates
|
| Thickness [mm]
| float
| thickness of the surface
|
| Start angle [deg]
| float
| start angle of the sphere in the azimuth direction
|
| End angle [deg]
| float
| end angle of the sphere in the azimuth direction
|
| X [mm]
| float
| X coordinate of the element origin
|
| Y [mm]
| float
| Y coordinate of the element origin
|
| Z [mm]
| float
| Z coordinate of the element origin
|
| rot X [deg]
| float
| X roation angle of the ZYX Euler angles
|
| rot Y [deg]
| float
| Y roation angle of the ZYX Euler angles
|
| rot Z [deg]
| float
| Z roation angle of the ZYX Euler angles
|
| Top optical property
| str
| name of the top side optical property
|
| Bottom optical property
| str
| name of the bottom side optical property
|
| Material
| str
| name of the bulk material
|
| Top analysis group
| str
| name of the top side analysis group
|
| Bottom analysis group
| str
| name of the bottom side analysis group
|
| Color
| int
| color code
|
| Comment
| str
| unique comment within the submodel for specifying the element
|
area_disk(disk: OpenTDv62.RadCAD.Disk)
This function returns the area of the given Disk element.
| parameter |
type |
description |
| disk
| OpenTDv62.RadCAD.Disk
| Instance of the Disk element
|
area_rectangle(disk: OpenTDv62.RadCAD.Rectangle)
This function returns the area of the given Rectangle element.
| parameter |
type |
description |
| disk
| OpenTDv62.RadCAD.Rectangle
| Instance of the Rectangle element
|
area_cylinder(disk: OpenTDv62.RadCAD.Cylinder)
This function returns the area of the given Cylinder element.
| parameter |
type |
description |
| disk
| OpenTDv62.RadCAD.Cylinder
| Instance of the Cylinder element
|
area_cone(disk: OpenTDv62.RadCAD.Cone)
This function returns the area of the given Cone element.
| parameter |
type |
description |
| disk
| OpenTDv62.RadCAD.Cone
| Instance of the Cone element
|
area_torus(disk: OpenTDv62.RadCAD.Torus)
This function returns the area of the given Torus element.
| parameter |
type |
description |
| disk
| OpenTDv62.RadCAD.Torus
| Instance of the Torus element
|
$$
\begin{align}
\mathrm{area} &= \int_{\varphi_{\mathrm{start}}}^{\varphi_{\mathrm{end}}} \int_{\theta_{\mathrm{start}}}^{\theta_{\mathrm{end}}} (R + r \cos \theta)d\varphi \times r d\theta \\
&= \left\{ Rr(\theta_{\mathrm{end}} - \theta_{\mathrm{start}}) + r^2 (\sin \theta_{\mathrm{end}} - \sin \theta_{\mathrm{start}}) \right\} (\varphi_{\mathrm{end}} - \varphi_{\mathrm{start}})
\end{align}
$$
$$
\begin{align}
\varphi&: \mathrm{Angle~of~the~large~radius} \\
\theta&: \mathrm{Angle~of~the~small~radius} \\
R&: \mathrm{Large~radius} \\
r&: \mathrm{Small~radius}
\end{align}
$$
area_scarfedcylinder(disk: OpenTDv62.RadCAD.ScarfedCylinder)
This function returns the area of the given ScarfedCylinder element.
| parameter |
type |
description |
| disk
| OpenTDv62.RadCAD.ScarfedCylinder
| Instance of the ScarfedCylinder element
|
$$
\begin{align}
\mathrm{area} &= \int_{\theta_{\mathrm{start}}}^{\theta_{\mathrm{end}}} (H - r \cos \theta~\tan \varphi) ~rd\theta \\
&= r H (\theta_\mathrm{end} - \theta_\mathrm{start}) - r^2 \tan \varphi (\sin \theta_\mathrm{end} - \sin \theta_\mathrm{start})
\end{align}
$$
$$
\begin{align}
H&: \mathrm{Height~of~the~cylinder~(middle~of~the~highest~and~lowest~edge)} \\
\theta&: \mathrm{Angle~of~the~cylinder} \\
r&: \mathrm{Radius~the~cylinder} \\
\varphi&: \mathrm{Scarf~angle}
\end{align}
$$
area_sphere(disk: OpenTDv62.RadCAD.Sphere)
This function returns the area of the given Sphere element.
| parameter |
type |
description |
| disk
| OpenTDv62.RadCAD.Sphere
| Instance of the Sphere element
|
$$
\begin{align}
\mathrm{area} &= \int_{h_{\mathrm{min}}}^{h_{\mathrm{max}}} 2\pi \sqrt{R^2 - h^2} \times \frac{R dh}{\sqrt{R^2 - h^2}} \times \frac{\theta_\mathrm{end} - \theta_\mathrm{start}}{2\pi} \\
&= R (h_\mathrm{max} - h_\mathrm{min}) (\theta_\mathrm{end} - \theta_\mathrm{start})
\end{align}
$$
$$
\begin{align}
h&: \mathrm{Height~parameter~of~the~sphere} \\
R&: \mathrm{Radius~of~the~sphere} \\
\theta_\mathrm{start}&: \mathrm{Start~anlge~of~the~sphere~surface,~[rad]} \\
\theta_\mathrm{end}&: \mathrm{End~anlge~of~the~sphere~surface,~[rad]}
\end{align}
$$