DefaultUnitsClass

class ansys.geometry.core.misc.measurements.DefaultUnitsClass

Provides default units for PyAnsys Geometry.

Overview

Methods

apply_length_scale

Align the default server length unit with a design length scale.

Properties

LENGTH	Default length unit for PyAnsys Geometry.
ANGLE	Default angle unit for PyAnsys Geometry.
AREA	Default area unit for PyAnsys Geometry.
VOLUME	Default volume unit for PyAnsys Geometry.
SERVER_LENGTH	Default length unit for gRPC messages.
SERVER_AREA	Default area unit for gRPC messages.
SERVER_VOLUME	Default volume unit for gRPC messages.
SERVER_ANGLE	Default angle unit for gRPC messages.

Import detail

from ansys.geometry.core.misc.measurements import DefaultUnitsClass

Property detail

property DefaultUnitsClass.LENGTH: pint.Unit

Default length unit for PyAnsys Geometry.

property DefaultUnitsClass.ANGLE: pint.Unit

Default angle unit for PyAnsys Geometry.

property DefaultUnitsClass.AREA: pint.Unit

Default area unit for PyAnsys Geometry.

property DefaultUnitsClass.VOLUME: pint.Unit

Default volume unit for PyAnsys Geometry.

property DefaultUnitsClass.SERVER_LENGTH: pint.Unit

Default length unit for gRPC messages.

Notes

The default units on the server side are not modifiable yet.

property DefaultUnitsClass.SERVER_AREA: pint.Unit

Default area unit for gRPC messages.

Notes

The default units on the server side are not modifiable yet.

property DefaultUnitsClass.SERVER_VOLUME: pint.Unit

Default volume unit for gRPC messages.

Notes

The default units on the server side are not modifiable yet.

property DefaultUnitsClass.SERVER_ANGLE: pint.Unit

Default angle unit for gRPC messages.

Notes

The default units on the server side are not modifiable yet.

Method detail

DefaultUnitsClass.apply_length_scale(length_scale: ansys.geometry.core.designer.design.LengthScale) → None

Align the default server length unit with a design length scale.

Parameters:

length_scaleLengthScale

Length scale of the design.