ECylinder Object

This object is used to create a new elliptical cylinder shape.

Methods

Reset

Resets all internal settings to their default values.

 

Name ( name ecylindername )

Sets the name of the elliptical cylinder.

 

Component ( name componentname  )

Sets the name of the component for the new elliptical cylinder. The component must already exist.

 

Material ( name materialname )

Sets the material name for the new elliptical cylinder. The material must already exist.

 

Axis ( enum{"x", "y", "z"} direction )

Sets the axis of the elliptical cylinder. According to this setting, either Xrange, Yrange or Zrange need to be set for the extension of the elliptical cylinder along the axis. Furthermore the radii for the two transversal directions need to be specified as Xradius, Yradius or Zradius. For example, an elliptical cylinder along the z-axis needs the specification of a Zrange and Xradius and Yradius.

 

Xradius ( double radius )

Sets the radius of the elliptical cylinder in the x- or u-direction, depending on whether a local coordinate system is active or not. This setting is only used if the axis of the elliptical cylinder has not been set to "x".

 

Yradius ( double radius )

Sets the radius of the elliptical cylinder in the y- or v-direction, depending on whether a local coordinate system is active or not. This setting is only used if the axis of the elliptical cylinder has not been set to "y".

 

Zradius ( double radius )

Sets the radius of the elliptical cylinder in the z- or w-direction, depending on whether a local coordinate system is active or not. This setting is only used if the axis of the elliptical cylinder has not been set to "z".

 

Xcenter ( double centercoordinate )

Sets the x- or u-coordinate of the center point of the bottom face of the elliptical cylinder, depending on whether a local coordinate system is active or not.

 

Ycenter ( double centercoordinate )

Sets the y- or v-coordinate of the center point of the bottom face of the elliptical cylinder, depending on whether a local coordinate system is active or not.

 

Zcenter ( double centercoordinate )

Sets the z- or w-coordinate of the center point of the bottom face of the elliptical cylinder, depending on whether a local coordinate system is active or not.

 

Xrange ( double xmin, double xmax )

Sets the bounds for the x- or u-coordinate extensions of the new elliptical cylinder depending on whether a local coordinate system is active or not. This setting is only used if the axis is set to "x".

 

Yrange ( double ymin, double ymax )

Sets the bounds for the y- or v-coordinate extensions of the new elliptical cylinder depending on whether a local coordinate system is active or not. This setting is only used if the axis is set to "y".

 

Zrange ( double zmin, double zmax )

Sets the bounds for the z- or w-coordinate extensions of the new elliptical cylinder depending on whether a local coordinate system is active or not. This setting is only used if the axis is set to "z".

 

Segments ( int number )

This setting specifies how the elliptical cylinder's geometry is modelled, either as a smooth surface of by a facetted approximation. If this value is set to "0", an analytical (smooth) representation of the elliptical cylinder will be created. If this number is set to another value greater than 2, the elliptical cylinder's face will be approximated by this number of planar facets. The higher the number of segments, the better the representation of the elliptical cylinder will be.

 

Create

Creates a new elliptical cylinder. All necessary settings for this cylinder have to be made previously.

Default Settings

Material ("Vacuum")

Xcenter (0)

Ycenter (0)

Zcenter (0)

Xrange (0, 0)

Yrange (0, 0)

Zrange (0, 0)

Segments (0)

Example

With ECylinder

    .Reset

    .Name ("ecylinder1")

    .Component ("component1")

    .Material ("PEC")

    .Axis ("z")

    .Xradius (1.5)

    .Yradius (0.5)

    .Xcenter (2)

    .Ycenter (1)

    .Zcenter (0)

    .Zrange (0, "a+3")

    .Segments (0)

    .Create

End With