shape.OpenBox

Create open box centered at origin

Since R2023b

expand all in page

    Description

    The shape.OpenBox lets you create an open box with metal and dielectric material properties centered at the origin. Use this open box along with the other shapes and the geometric operations to create a shape for the custom antenna.

    Creation

    Syntax

    openbox = shape.OpenBox
    openbox = shape.OpenBox(PropertyName=Value)

    Description

    openbox = shape.OpenBox creates a hollow box with one open face, centered at the origin.

    example

    openbox = shape.OpenBox(PropertyName=Value) sets properties using one or more name-value arguments. PropertyName is the property name and Value is the corresponding value. You can specify several name-value arguments in any order as PropertyName1=Value1, ..., PropertyNameN=ValueN. Properties that you do not specify retain their default values.

    For example, box = shape.OpenBox(Height=4) creates an open face box with a height of 4 m along the z-axis and default values for other properties.

    Properties

    expand all

    Open box name, specified as a string.

    Example: "OpenBox1"

    Data Types: string

    Open box center point, specified as a three-element vector of Cartesian coordinates in meters.

    Example: [1 1 1]

    Data Types: double

    Length of the open box along the x-axis, specified as a scalar in meters.

    Example: 2

    Data Types: double

    Width of the open box along the y-axis, specified as a scalar in meters.

    Example: 4

    Data Types: double

    Height of the box along the z-axis, specified as a scalar in meters.

    Example: 4

    Data Types: double

    Metal material of the shape, specified as a metal name string from the Metal Catalog. To use the shape as a pure metal, set the Dielectric property to "Air". To create a metal-dielectric shape, use the addSubstrate function.

    Example: "Copper"

    Data Types: string

    Dielectric material of the shape, specified as a dielectric name string from the Dielectric Catalog. To use the shape as a pure dielectric, set this property's value to a material other than "Air". In this scenario, value specified in the Metal property is ignored. To create a metal-dielectric shape, use the addSubstrate function.

    Example: "Teflon"

    Data Types: string

    Frequency dispersion model for dielectric material, specified as a string. The default frequency model is Constant. Other supported frequency models are as below:

    • Frequency independent: Constant

    • Frequency dependent: DjordjevicSarkar and MeanDjordjevicSarkar

    The DjordjevicSarkar model uses extrapolation techniques to predict properties of dielectric materials over a wide frequency range from a single frequency point measurement. The MeanDjordjevicSarkar model uses average value of the DjordjevicSarkar model over a frequency range of interest to predict properties of dielectric materials. Use the frequency independent model for narrow band applications. Use the frequency dependent models for wideband applications.

    Example: "DjordjevicSarkar"

    Data Types: string

    Color of shape, specified as either a character for color short name or a three-element real vector of RGB triplets. The default shape color is yellow. See the Types of Color Values supported by this property. When you unite two shapes of different colors, use "Individual" value to retain the colors of the original shapes in the resultant shape.

    Example: "r"

    Example: [0 0.447 0.741]

    Data Types: double | string | char

    Transparency of shape, specified as a scalar in the (0,1) range, where 0 corresponds to full transparency while 1 corresponds to full opaqueness.

    Example: 0.75

    Data Types: double

    Color of shape edges, specified as either a character for color short name or a three-element real vector of RGB triplets. The default edge color is black. See the Types of Color Values supported by this property. When you unite two shapes of different edge colors, use "Individual" value to retain the edge colors of the original shapes in the resultant shape.

    Example: "b"

    Example: [0.4940 0.1840 0.5560]

    Data Types: double | string | char

    Object Functions

    expand all

    addPerform Boolean unite operation on two shapes
    andPerform Boolean intersection operation on two shapes
    intersectGenerate and plot intersection of two shapes
    minusCarve a shape from other shape
    plusJoin two shapes
    subtractPerform Boolean subtraction operation on two shapes
    addSubstrateCreate metal-dielectric shape
    createHoleCreate a 2-D hole on custom shape
    extrudeExtrude 2-D shape on another shape
    imprintShapeImprint 2-D shape on another shape
    removeFacesInteractively select and remove 3-D shape faces
    rotateRotate shape about axis by angle
    rotateXRotate shape about x-axis by angle
    rotateYRotate shape about y-axis by angle
    rotateZRotate shape about z-axis by angle
    scaleChange size of shape by fixed factor
    translateMove shape to new location
    getShapeVerticesFind shape vertices
    meshGenerate and view mesh for antennas, arrays, and custom shapes
    showDisplay antenna, array structures, shapes, or platform

    Examples

    collapse all

    Open Live Script

    Create a 2 cm x 2 cm x 2cm open box. Rotate it by 45 degrees around the z-axis.

    r = shape.OpenBox(Length=0.02,Width=0.02,Height=0.02);
rotateZ(r,45);

    Figure contains an axes object. The axes object with xlabel x (mm), ylabel y (mm) contains 2 objects of type patch.

    Mesh it with a maximum edge length of 5 mm.

    mesh(r,MaxEdgeLength=5e-3)

    Figure contains an axes object. The axes object with xlabel x (m), ylabel y (m) contains an object of type patch.

    Version History

    Introduced in R2023b

    expand all

    See Also

    Objects

    Functions