Variable descriptor#
Package initialization for ansys.units.variable_descriptor.
Exports the VariableCatalog catalog and core interfaces for working with physical quantities in a product-agnostic way.
Example#
from ansys.units.variable_descriptor import VariableCatalog
from ansys.fluent.core.variable_strategies import FluentSVarNamingStrategy
quantity = VariableCatalog.PRESSURE
strategy = FluentSVarNamingStrategy()
print(strategy.to_string(quantity))
- class ansys.units.variable_descriptor.ConversionStrategy#
Bases:
ABCAbstract base class for VariableDescriptor conversion strategies.
This class defines the interface for all conversion strategies. Derived classes must implement the methods defined here to handle the conversion of VariableDescriptor objects to and from their string representations, as well as to check if a VariableDescriptor is supported.
- abstract supports(variable: VariableDescriptor) bool#
Check if the given VariableDescriptor is supported by the strategy.
- Parameters:
- variable
VariableDescriptor The VariableDescriptor to check.
- variable
- Returns:
- bool
True if the VariableDescriptor is supported, False otherwise.
- Raises:
NotImplementedErrorIf the method is not implemented in a derived class.
- abstract to_string(variable: VariableDescriptor | str | None) str | None#
Convert a VariableDescriptor to its string representation.
- Parameters:
- variable
VariableDescriptor|str The VariableDescriptor to convert, or a string representation.
- variable
- Returns:
strThe string representation of the VariableDescriptor.
- Raises:
NotImplementedErrorIf the method is not implemented in a derived class.
- abstract to_variable_descriptor(variable: VariableDescriptor | str) VariableDescriptor | None#
Convert a string to its corresponding VariableDescriptor.
- Parameters:
- variable
VariableDescriptor|str The string representation to convert, or a VariableDescriptor.
- variable
- Returns:
VariableDescriptorThe corresponding VariableDescriptor instance.
- Raises:
NotImplementedErrorIf the method is not implemented in a derived class.
- class ansys.units.variable_descriptor.MappingConversionStrategy#
Bases:
ConversionStrategy,ABCIntermediate base class for implementing VariableDescriptor conversion strategies.
This class simplifies the creation of concrete strategy classes by providing default implementations for common methods. Classes inheriting from this base class only need to define a _mapping dictionary that maps VariableDescriptor instances to their corresponding string representations.
- Attributes:
_reverse_mappingdictGet the reverse mapping of _mapping.
Methods
to_string(variable: VariableDescriptor | str) -> str
Converts a VariableDescriptor to its string representation. Raises a ValueError if the variable is not supported.
to_variable_descriptor(variable: VariableDescriptor | str) -> VariableDescriptor
Converts a string to its corresponding VariableDescriptor.
supports(variable: VariableDescriptor) -> bool
Checks if the given VariableDescriptor is supported by the strategy.
- Raises:
ValueErrorIf a VariableDescriptor is not supported during conversion to a string.
- supports(variable: VariableDescriptor) bool#
Check if the given VariableDescriptor is supported by the strategy.
- Parameters:
- variable
VariableDescriptor The VariableDescriptor to check.
- variable
- Returns:
- bool
True if the VariableDescriptor is supported, False otherwise.
- to_string(variable: VariableDescriptor | str | None) str | None#
Convert a VariableDescriptor to its string representation.
If the input is already a string, it is returned as-is. If the input is a VariableDescriptor and is supported by the strategy, its string representation is returned. Otherwise, a ValueError is raised.
- Parameters:
- variable
VariableDescriptor|str The VariableDescriptor to convert, or a string representation.
- variable
- Returns:
strThe string representation of the VariableDescriptor.
- Raises:
ValueErrorIf the VariableDescriptor is not supported by the strategy.
- to_variable_descriptor(variable: VariableDescriptor | str) VariableDescriptor | None#
Convert a string to its corresponding VariableDescriptor.
If the input is already a VariableDescriptor, it is returned as-is. Otherwise, the string is converted to a VariableDescriptor using the reverse mapping.
- Parameters:
- variable
VariableDescriptor|str The string representation to convert, or a VariableDescriptor.
- variable
- Returns:
VariableDescriptorThe corresponding VariableDescriptor instance, or None if the string is not found in the reverse mapping.
- class ansys.units.variable_descriptor.ScalarVariableDescriptor(dimension: Dimensions)#
Bases:
VariableDescriptor[Literal[SCALAR]]Concrete class for scalar variables supporting runtime isinstance checks.
- class ansys.units.variable_descriptor.VariableCatalog#
Bases:
VariableCatalogBaseA catalog of variable descriptors.
- ABSOLUTE_PRESSURE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='absolute_pressure')#
Pressure measured relative to a perfect vacuum (zero reference).
- ABSORBANCE = ScalarVariableDescriptor(dimension={}, name='absorbance')#
Logarithmic measure of the amount of light absorbed by a material.
- ABSORBED_DOSE_RATE = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -3.0}, name='absorbed_dose_rate')#
Rate at which radiation energy is absorbed per unit mass.
- ACCELERATION = VectorVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -2.0}, name='acceleration')#
Rate of change of velocity with respect to time.
- ACCELERATION_MAGNITUDE = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -2.0}, name='acceleration_magnitude')#
Magnitude of the acceleration vector.
- ACCELERATION_X = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -2.0}, name='acceleration_x')#
Component of acceleration along the x-axis.
- ACCELERATION_Y = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -2.0}, name='acceleration_y')#
Component of acceleration along the y-axis.
- ACCELERATION_Z = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -2.0}, name='acceleration_z')#
Component of acceleration along the z-axis.
- ACOUSTICAL_ABSORPTION = ScalarVariableDescriptor(dimension={}, name='acoustical_absorption')#
Fraction of incident sound energy absorbed by a surface.
- ACTION = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -1.0}, name='action')#
Product of energy and time characterizing a system’s dynamics.
- ANGLE = ScalarVariableDescriptor(dimension={'ANGLE': 1.0}, name='angle')#
Measure of rotation or the figure formed by two intersecting lines.
- ANGULAR_ACCELERATION = ScalarVariableDescriptor(dimension={'TIME': -2.0}, name='angular_acceleration')#
Rate of change of angular velocity with respect to time.
- ANGULAR_MOMENTUM = VectorVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -1.0}, name='angular_momentum')#
Rotational analog of linear momentum for a rotating body.
- ANGULAR_MOMENTUM_MAGNITUDE = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -1.0}, name='angular_momentum_magnitude')#
Magnitude of the angular momentum vector.
- ANGULAR_MOMENTUM_X = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -1.0}, name='angular_momentum_x')#
Component of angular momentum about the x-axis.
- ANGULAR_MOMENTUM_Y = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -1.0}, name='angular_momentum_y')#
Component of angular momentum about the y-axis.
- ANGULAR_MOMENTUM_Z = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -1.0}, name='angular_momentum_z')#
Component of angular momentum about the z-axis.
- ANGULAR_VELOCITY = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='angular_velocity')#
Rate of change of angular position with respect to time.
- AREA = ScalarVariableDescriptor(dimension={'LENGTH': 2.0}, name='area')#
Extent of a two-dimensional surface or region.
- AREA_DENSITY = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -2.0}, name='area_density')#
Mass per unit area of a surface.
- ATOMIC_MASS = ScalarVariableDescriptor(dimension={'MASS': 1.0}, name='atomic_mass')#
Mass of a single atom.
- ATOMIC_NUMBER = ScalarVariableDescriptor(dimension={}, name='atomic_number')#
Number of protons in the nucleus of an atom.
- ATTENUATION_COEFFICIENT = ScalarVariableDescriptor(dimension={'LENGTH': -1.0}, name='attenuation_coefficient')#
Rate at which a quantity decreases as it passes through a medium.
- AXIAL_VELOCITY = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -1.0}, name='axial_velocity')#
Velocity component along the axial direction.
- BIREFRINGENCE = ScalarVariableDescriptor(dimension={}, name='birefringence')#
Difference in refractive index seen by light of different polarizations.
- BULK_MODULUS = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='bulk_modulus')#
Resistance of a material to uniform compression.
- CAPACITANCE = ScalarVariableDescriptor(dimension={'MASS': -1.0, 'LENGTH': -2.0, 'TIME': 4.0, 'CURRENT': 2.0}, name='capacitance')#
Ability of a system to store electric charge per unit voltage.
- CATALYTIC_EFFICIENCY = ScalarVariableDescriptor(dimension={'LENGTH': 3.0, 'CHEMICAL_AMOUNT': -1.0, 'TIME': -1.0}, name='catalytic_efficiency')#
Measure of how effectively an enzyme converts substrate to product.
- CELL_REYNOLDS_NUMBER = ScalarVariableDescriptor(dimension={}, name='cell_reynolds_number')#
Reynolds number evaluated at the length scale of a mesh cell.
- CHEMICAL_AMOUNT = ScalarVariableDescriptor(dimension={'CHEMICAL_AMOUNT': 1.0}, name='chemical_amount')#
Quantity of substance measured in moles.
- COEFFICIENT_OF_RESTITUTION = ScalarVariableDescriptor(dimension={}, name='coefficient_of_restitution')#
Ratio of relative speeds after and before an impact.
- COLOR = ScalarVariableDescriptor(dimension={}, name='color')#
Qualitative visual property determined by the wavelength of light.
- COMPRESSIBILITY = ScalarVariableDescriptor(dimension={'MASS': -1.0, 'LENGTH': 1.0, 'TIME': 2.0}, name='compressibility')#
Relative volume change of a fluid or solid in response to pressure.
- COMPRESSIVE_STRENGTH = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='compressive_strength')#
Maximum compressive stress a material can withstand before failure.
- CONVECTIVE_COURANT_NUMBER = ScalarVariableDescriptor(dimension={}, name='convective_courant_number')#
Ratio of flow distance to cell size over a time step, indicating numerical stability.
- CORROSION_RESISTANCE = ScalarVariableDescriptor(dimension={}, name='corrosion_resistance')#
Ability of a material to resist degradation by chemical reaction.
- CREEP = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='creep')#
Slow, time-dependent deformation of a material under sustained stress.
- CURIE_TEMPERATURE = ScalarVariableDescriptor(dimension={'TEMPERATURE': 1.0}, name='curie_temperature')#
Temperature above which a material loses its permanent magnetism.
- CURRENT = ScalarVariableDescriptor(dimension={'CURRENT': 1.0}, name='current')#
Flow of electric charge per unit time.
- DENSITY = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -3.0}, name='density')#
Mass per unit volume of a substance.
- DIAMAGNETISM = ScalarVariableDescriptor(dimension={}, name='diamagnetism')#
Tendency of a material to be weakly repelled by a magnetic field.
- DIELECTRIC_CONSTANT = ScalarVariableDescriptor(dimension={}, name='dielectric_constant')#
Relative permittivity of a material compared with vacuum.
- DIELECTRIC_STRENGTH = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 1.0, 'TIME': -3.0, 'CURRENT': -1.0}, name='dielectric_strength')#
Maximum electric field a material can withstand without breaking down.
- DUCTILITY = ScalarVariableDescriptor(dimension={}, name='ductility')#
Ability of a material to deform plastically before fracture.
- DURABILITY = ScalarVariableDescriptor(dimension={}, name='durability')#
Ability of a material to withstand wear, pressure, or damage over time.
- DVELOCITY_DX = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='dvelocity_dx')#
Spatial derivative of velocity with respect to the x-coordinate.
- DVELOCITY_DX_MAGNITUDE = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='dvelocity_dx_magnitude')#
Magnitude of the velocity derivative with respect to x.
- DVELOCITY_DX_X = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='dvelocity_dx_x')#
X-component of the velocity derivative with respect to x.
- DVELOCITY_DX_Y = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='dvelocity_dx_y')#
Y-component of the velocity derivative with respect to x.
- DVELOCITY_DX_Z = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='dvelocity_dx_z')#
Z-component of the velocity derivative with respect to x.
- DVELOCITY_DY = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='dvelocity_dy')#
Spatial derivative of velocity with respect to the y-coordinate.
- DVELOCITY_DY_MAGNITUDE = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='dvelocity_dy_magnitude')#
Magnitude of the velocity derivative with respect to y.
- DVELOCITY_DY_X = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='dvelocity_dy_x')#
X-component of the velocity derivative with respect to y.
- DVELOCITY_DY_Y = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='dvelocity_dy_y')#
Y-component of the velocity derivative with respect to y.
- DVELOCITY_DY_Z = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='dvelocity_dy_z')#
Z-component of the velocity derivative with respect to y.
- DVELOCITY_DZ = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='dvelocity_dz')#
Spatial derivative of velocity with respect to the z-coordinate.
- DVELOCITY_DZ_MAGNITUDE = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='dvelocity_dz_magnitude')#
Magnitude of the velocity derivative with respect to z.
- DVELOCITY_DZ_X = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='dvelocity_dz_x')#
X-component of the velocity derivative with respect to z.
- DVELOCITY_DZ_Y = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='dvelocity_dz_y')#
Y-component of the velocity derivative with respect to z.
- DVELOCITY_DZ_Z = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='dvelocity_dz_z')#
Z-component of the velocity derivative with respect to z.
- DYNAMIC_PRESSURE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='dynamic_pressure')#
Kinetic energy per unit volume of a moving fluid.
- DYNAMIC_VISCOSITY = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -1.0}, name='dynamic_viscosity')#
Measure of a fluid’s resistance to shear flow.
- EFFECTIVE_PRANDTL_NUMBER = ScalarVariableDescriptor(dimension={}, name='effective_prandtl_number')#
Prandtl number adjusted for turbulent transport effects.
- EFFECTIVE_THERMAL_CONDUCTIVITY = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'MASS': 1.0, 'TIME': -3.0, 'TEMPERATURE': -1.0}, name='effective_thermal_conductivity')#
Thermal conductivity including the effect of turbulent mixing.
- EFFECTIVE_VISCOSITY = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -1.0}, name='effective_viscosity')#
Total viscosity combining molecular and turbulent contributions.
- ELASTICITY = ScalarVariableDescriptor(dimension={}, name='elasticity')#
Ability of a material to return to its original shape after deformation.
- ELECTRICAL_CAPACITANCE = ScalarVariableDescriptor(dimension={'MASS': -1.0, 'LENGTH': -2.0, 'TIME': 4.0, 'CURRENT': 2.0}, name='electrical_capacitance')#
Ability of a component to store electric charge per unit voltage.
- ELECTRICAL_CONDUCTANCE = ScalarVariableDescriptor(dimension={'MASS': -1.0, 'LENGTH': -2.0, 'TIME': 3.0, 'CURRENT': 2.0}, name='electrical_conductance')#
Ease with which electric current flows through a conductor.
- ELECTRICAL_CONDUCTIVITY = ScalarVariableDescriptor(dimension={'MASS': -1.0, 'LENGTH': -3.0, 'TIME': 3.0, 'CURRENT': 2.0}, name='electrical_conductivity')#
Material’s ability to conduct electric current per unit length.
- ELECTRICAL_IMPEDANCE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 2.0, 'TIME': -3.0, 'CURRENT': -2.0}, name='electrical_impedance')#
Opposition of a circuit to alternating current, including resistance and reactance.
- ELECTRICAL_INDUCTANCE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 2.0, 'TIME': -2.0, 'CURRENT': -2.0}, name='electrical_inductance')#
Property of a conductor that opposes changes in electric current.
- ELECTRICAL_POTENTIAL = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 2.0, 'TIME': -3.0, 'CURRENT': -1.0}, name='electrical_potential')#
Electric potential energy per unit charge (voltage).
- ELECTRICAL_REACTANCE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 2.0, 'TIME': -3.0, 'CURRENT': -2.0}, name='electrical_reactance')#
Opposition to alternating current due to capacitance or inductance.
- ELECTRICAL_RESISTANCE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 2.0, 'TIME': -3.0, 'CURRENT': -2.0}, name='electrical_resistance')#
Opposition of a material to the flow of electric current.
- ELECTRICAL_RESISTIVITY = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 3.0, 'TIME': -3.0, 'CURRENT': -2.0}, name='electrical_resistivity')#
Intrinsic resistance of a material per unit length and area.
- ELECTRIC_CHARGE = ScalarVariableDescriptor(dimension={'TIME': 1.0, 'CURRENT': 1.0}, name='electric_charge')#
Fundamental property of matter that causes electromagnetic interaction.
- ELECTRIC_SUSCEPTIBILITY = ScalarVariableDescriptor(dimension={}, name='electric_susceptibility')#
Degree to which a material becomes polarized in an electric field.
- ELECTROCALORIC_COEFFICIENT = ScalarVariableDescriptor(dimension={'TEMPERATURE': 1.0, 'MASS': -1.0, 'LENGTH': -2.0, 'TIME': 3.0, 'CURRENT': 1.0}, name='electrocaloric_coefficient')#
Temperature change of a material per unit applied electric field.
- ELECTROSTRICTION = ScalarVariableDescriptor(dimension={}, name='electrostriction')#
Strain produced in a dielectric material by an applied electric field.
- ELECTRO_OPTIC_EFFECT = ScalarVariableDescriptor(dimension={}, name='electro_optic_effect')#
Change in a material’s refractive index caused by an electric field.
- EMISSIVITY = ScalarVariableDescriptor(dimension={}, name='emissivity')#
Effectiveness of a surface in emitting thermal radiation relative to a blackbody.
- ENERGY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -2.0}, name='energy')#
Capacity to do work or produce heat.
- ENERGY_DENSITY = ScalarVariableDescriptor(dimension={'LENGTH': -1.0, 'MASS': 1.0, 'TIME': -2.0}, name='energy_density')#
Amount of energy stored per unit volume.
- ENERGY_FLUX_DENSITY = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'TIME': -3.0}, name='energy_flux_density')#
Rate of energy transfer per unit area.
- ENTHALPY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -2.0}, name='enthalpy')#
Total heat content of a system at constant pressure.
- ENTROPY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -2.0, 'TEMPERATURE': -1.0}, name='entropy')#
Measure of the disorder or unavailable energy in a system.
- FATIGUE_LIMIT = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='fatigue_limit')#
Maximum stress a material can endure for an infinite number of loading cycles.
- FLEXURAL_MODULUS = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='flexural_modulus')#
Material’s resistance to bending deformation.
- FLEXURAL_STRENGTH = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='flexural_strength')#
Maximum bending stress a material can withstand before failure.
- FORCE = VectorVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 1.0, 'TIME': -2.0}, name='force')#
Interaction that changes the motion of a body.
- FORCE_MAGNITUDE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 1.0, 'TIME': -2.0}, name='force_magnitude')#
Magnitude of the force vector.
- FORCE_X = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 1.0, 'TIME': -2.0}, name='force_x')#
Component of force along the x-axis.
- FORCE_Y = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 1.0, 'TIME': -2.0}, name='force_y')#
Component of force along the y-axis.
- FORCE_Z = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 1.0, 'TIME': -2.0}, name='force_z')#
Component of force along the z-axis.
- FRACTURE_TOUGHNESS = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'TIME': -2.0}, name='fracture_toughness')#
Resistance of a material to crack propagation.
- FREQUENCY = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='frequency')#
Number of occurrences of a repeating event per unit time.
- FREQUENCY_DRIFT = ScalarVariableDescriptor(dimension={'TIME': -2.0}, name='frequency_drift')#
Rate of change of frequency over time.
- FRICTION_COEFFICIENT = ScalarVariableDescriptor(dimension={}, name='friction_coefficient')#
Ratio of frictional force to normal force between surfaces.
- FUEL_EFFICIENCY = ScalarVariableDescriptor(dimension={'LENGTH': -2.0}, name='fuel_efficiency')#
Distance traveled per unit volume of fuel consumed.
- HALF_LIFE = ScalarVariableDescriptor(dimension={'TIME': 1.0}, name='half_life')#
Time required for a quantity to reduce to half its initial value.
- HALL_COEFFICIENT = ScalarVariableDescriptor(dimension={'LENGTH': 3.0, 'CURRENT': -1.0, 'TIME': -1.0}, name='hall_coefficient')#
Measure of the voltage developed across a conductor in a magnetic field.
- HARDNESS = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='hardness')#
Resistance of a material to localized plastic deformation.
- HEAT_CAPACITY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -2.0, 'TEMPERATURE': -1.0}, name='heat_capacity')#
Amount of heat required to change a body’s temperature by one degree.
- HEAT_FLUX_DENSITY = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'TIME': -3.0}, name='heat_flux_density')#
Rate of heat transfer per unit area.
- HEAT_OF_VAPORIZATION = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -2.0}, name='heat_of_vaporization')#
Energy required to vaporize a unit mass of a substance.
- HELICITY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -1.0}, name='helicity')#
In particle physics, the projection of a particle’s spin onto its direction of motion.
- HYDRODYNAMICAL_HELICITY = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -2.0}, name='hydrodynamical_helicity')#
In fluid dynamics, a measure of the knottedness and/or linkage of the vortex lines of a flow.
- HYGROSCOPY = ScalarVariableDescriptor(dimension={}, name='hygroscopy')#
Tendency of a material to absorb moisture from the air.
- HYSTERESIS = ScalarVariableDescriptor(dimension={}, name='hysteresis')#
Dependence of a system’s state on its history of applied conditions.
- ILLUMINANCE = ScalarVariableDescriptor(dimension={'LIGHT': 1.0, 'SOLID_ANGLE': 1.0, 'LENGTH': -2.0}, name='illuminance')#
Luminous flux incident on a surface per unit area.
- INTERNAL_ENERGY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -2.0}, name='internal_energy')#
Total energy contained within a thermodynamic system.
- JERK = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -3.0}, name='jerk')#
Rate of change of acceleration with respect to time.
- KINEMATIC_VISCOSITY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -1.0}, name='kinematic_viscosity')#
Ratio of dynamic viscosity to fluid density.
- LAMBDA_2_CRITERION = ScalarVariableDescriptor(dimension={'TIME': -2.0}, name='lambda_2_criterion')#
The lambda 2 criterion, which concerns the definition of the scalar lambda2 and how turbulent structures can be visualized by proper iso-surfaces of lambda2 (like for the Q criterion).
- LENGTH = ScalarVariableDescriptor(dimension={'LENGTH': 1.0}, name='length')#
Measure of distance or extent in one dimension.
- LIGHT = ScalarVariableDescriptor(dimension={'LIGHT': 1.0}, name='light')#
Luminous intensity of a light source.
- LINEAR_MASS_DENSITY = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0}, name='linear_mass_density')#
Mass per unit length of an object.
- LUMINANCE = ScalarVariableDescriptor(dimension={'LIGHT': 1.0, 'LENGTH': -2.0}, name='luminance')#
Luminous intensity per unit area of a surface.
- LUMINOSITY = ScalarVariableDescriptor(dimension={'LIGHT': 1.0, 'SOLID_ANGLE': 1.0}, name='luminosity')#
Total luminous flux emitted by a source.
- LUMINOUS_EXPOSURE = ScalarVariableDescriptor(dimension={'LIGHT': 1.0, 'SOLID_ANGLE': 1.0, 'LENGTH': -2.0, 'TIME': 1.0}, name='luminous_exposure')#
Illuminance accumulated over a period of time.
- LUMINOUS_FLUX = ScalarVariableDescriptor(dimension={'LIGHT': 1.0, 'SOLID_ANGLE': 1.0}, name='luminous_flux')#
Total perceived power of light emitted by a source.
- MAGNETIC_FLUX = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 2.0, 'TIME': -2.0, 'CURRENT': -1.0}, name='magnetic_flux')#
Total magnetic field passing through a given area.
- MAGNETIC_HELICITY = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'MASS': 2.0, 'TIME': -4.0, 'CURRENT': -2.0}, name='magnetic_helicity')#
In plasma physics and magnetohydrodynamics, a measure of the twist, linkage, and writhe of magnetic field lines within a volume.
- MAGNETIC_INDUCTION = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'TIME': -2.0, 'CURRENT': -1.0}, name='magnetic_induction')#
Magnetic flux density, or strength of a magnetic field.
- MAGNETIC_PERMEABILITY = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'MASS': 1.0, 'TIME': -2.0, 'CURRENT': -2.0}, name='magnetic_permeability')#
Ability of a material to support the formation of a magnetic field.
- MAGNETIC_VECTOR_POTENTIAL = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'MASS': 1.0, 'TIME': -2.0, 'CURRENT': -1.0}, name='magnetic_vector_potential')#
Vector field whose curl gives the magnetic flux density.
- MAGNETOCALORIC_COEFFICIENT = ScalarVariableDescriptor(dimension={'TEMPERATURE': 1.0, 'MASS': -1.0, 'TIME': 2.0, 'CURRENT': 1.0}, name='magnetocaloric_coefficient')#
Temperature change of a material per unit applied magnetic field.
- MAGNETOELECTRIC_POLARIZABILITY = ScalarVariableDescriptor(dimension={'LENGTH': -1.0, 'TIME': -1.0}, name='magnetoelectric_polarizability')#
Coupling between electric polarization and magnetic field in a material.
- MAGNETORESISTANCE = ScalarVariableDescriptor(dimension={}, name='magnetoresistance')#
Change in electrical resistance of a material in a magnetic field.
- MAGNETOSTRICTION = ScalarVariableDescriptor(dimension={}, name='magnetostriction')#
Change in a material’s dimensions due to magnetization.
- MAGNETOTHERMOELECTRIC_POWER = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -1.0, 'TEMPERATURE': -1.0}, name='magnetothermoelectric_power')#
Thermoelectric voltage generated per unit temperature and magnetic field.
- MALLEABILITY = ScalarVariableDescriptor(dimension={}, name='malleability')#
Ability of a material to be deformed under compression without fracture.
- MASS = ScalarVariableDescriptor(dimension={'MASS': 1.0}, name='mass')#
Measure of the amount of matter in a body.
- MASS_CONTROL = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'TIME': -3.0}, name='mass_control')#
Control quantity representing the third time derivative of mass.
- MASS_DIFFUSIVITY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -1.0}, name='mass_diffusivity')#
Rate at which mass diffuses through a medium.
- MASS_FLOW_RATE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'TIME': -1.0}, name='mass_flow_rate')#
Mass of fluid passing through a section per unit time.
- MASS_IMBALANCE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'TIME': -1.0}, name='mass_imbalance')#
Residual mass source indicating continuity error in a solution.
- MAXIMUM_ENERGY_PRODUCT = ScalarVariableDescriptor(dimension={'LENGTH': -1.0, 'MASS': 1.0, 'TIME': -2.0}, name='maximum_energy_product')#
Maximum energy density stored in a permanent magnet.
- MELTING_POINT = ScalarVariableDescriptor(dimension={'TEMPERATURE': 1.0}, name='melting_point')#
Temperature at which a solid becomes a liquid.
- MESH_ACTIVE_CELL_PARTITION = ScalarVariableDescriptor(dimension={}, name='mesh_active_cell_partition')#
Active partition index assigned to a mesh cell.
- MESH_ANISOTROPIC_ADAPTION_CELLS = ScalarVariableDescriptor(dimension={}, name='mesh_anisotropic_adaption_cells')#
Number of cells marked for anisotropic mesh adaption.
- MESH_BOUNDARY_CELL_DISTANCE = ScalarVariableDescriptor(dimension={}, name='mesh_boundary_cell_distance')#
Number of cells between a cell and the nearest boundary.
- MESH_BOUNDARY_LAYER_CELLS = ScalarVariableDescriptor(dimension={}, name='mesh_boundary_layer_cells')#
Count of cells within the boundary layer region.
- MESH_BOUNDARY_NORMAL_DISTANCE = ScalarVariableDescriptor(dimension={}, name='mesh_boundary_normal_distance')#
Normal distance from a cell to the nearest boundary.
- MESH_BOUNDARY_VOLUME_DISTANCE = ScalarVariableDescriptor(dimension={}, name='mesh_boundary_volume_distance')#
Volume-weighted distance from a cell to the boundary.
- MESH_CELL_ELEMENT_TYPE = ScalarVariableDescriptor(dimension={}, name='mesh_cell_element_type')#
Geometric element type of a mesh cell.
- MESH_CELL_EQUIANGLE_SKEW = ScalarVariableDescriptor(dimension={}, name='mesh_cell_equiangle_skew')#
Measure of cell skewness based on deviation from ideal angles.
- MESH_CELL_EQUIVOLUME_SKEW = ScalarVariableDescriptor(dimension={}, name='mesh_cell_equivolume_skew')#
Measure of cell skewness based on deviation from ideal volume.
- MESH_CELL_ID = ScalarVariableDescriptor(dimension={}, name='mesh_cell_id')#
Unique identifier of a mesh cell.
- MESH_CELL_PARENT_INDEX = ScalarVariableDescriptor(dimension={}, name='mesh_cell_parent_index')#
Index of the parent cell in a refined mesh.
- MESH_CELL_REFINE_LEVEL = ScalarVariableDescriptor(dimension={}, name='mesh_cell_refine_level')#
Refinement level of a mesh cell.
- MESH_CELL_VOLUME = ScalarVariableDescriptor(dimension={'LENGTH': 3.0}, name='mesh_cell_volume')#
Volume of a mesh cell.
- MESH_CELL_VOLUME_CHANGE = ScalarVariableDescriptor(dimension={}, name='mesh_cell_volume_change')#
Relative change in cell volume between mesh states.
- MESH_CELL_WEIGHT = ScalarVariableDescriptor(dimension={}, name='mesh_cell_weight')#
Computational weight assigned to a mesh cell for load balancing.
- MESH_CELL_ZONE_INDEX = ScalarVariableDescriptor(dimension={}, name='mesh_cell_zone_index')#
Index of the zone to which a mesh cell belongs.
- MESH_CELL_ZONE_TYPE = ScalarVariableDescriptor(dimension={}, name='mesh_cell_zone_type')#
Type of the zone to which a mesh cell belongs.
- MESH_ELEMENT_ASPECT_RATIO = ScalarVariableDescriptor(dimension={}, name='mesh_element_aspect_ratio')#
Ratio of the longest to shortest dimension of a mesh element.
- MESH_ELEMENT_WALL_DISTANCE = ScalarVariableDescriptor(dimension={'LENGTH': 1.0}, name='mesh_element_wall_distance')#
Distance from a mesh element to the nearest wall.
- MESH_FACE_AREA_MAGNITUDE = ScalarVariableDescriptor(dimension={'LENGTH': 2.0}, name='mesh_face_area_magnitude')#
Magnitude of the area of a mesh face.
- MESH_FACE_HANDEDNESS = ScalarVariableDescriptor(dimension={}, name='mesh_face_handedness')#
Orientation consistency of a mesh face.
- MESH_INTERFACE_OVERLAP_FRACTION = ScalarVariableDescriptor(dimension={}, name='mesh_interface_overlap_fraction')#
Fraction of overlap between mesh interfaces.
- MESH_MARK_POOR_ELEMENTS = ScalarVariableDescriptor(dimension={}, name='mesh_mark_poor_elements')#
Flag identifying mesh elements of poor quality.
- MESH_PARTITION_NEIGHBOURS = ScalarVariableDescriptor(dimension={}, name='mesh_partition_neighbours')#
Number of neighboring partitions for a mesh cell.
- MESH_SMOOTHED_CELL_REFINE_LEVEL = ScalarVariableDescriptor(dimension={}, name='mesh_smoothed_cell_refine_level')#
Smoothed refinement level across neighboring cells.
- MESH_STORED_CELL_PARTITION = ScalarVariableDescriptor(dimension={}, name='mesh_stored_cell_partition')#
Stored partition index assigned to a mesh cell.
- MESH_VELOCITY = VectorVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -1.0}, name='mesh_velocity')#
Velocity of mesh nodes in a moving or deforming grid.
- MESH_VELOCITY_MAGNITUDE = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -1.0}, name='mesh_velocity_magnitude')#
Magnitude of the mesh velocity vector.
- MESH_VELOCITY_X = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -1.0}, name='mesh_velocity_x')#
Component of mesh velocity along the x-axis.
- MESH_VELOCITY_Y = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -1.0}, name='mesh_velocity_y')#
Component of mesh velocity along the y-axis.
- MESH_VELOCITY_Z = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -1.0}, name='mesh_velocity_z')#
Component of mesh velocity along the z-axis.
- MESH_X_FACE_AREA = ScalarVariableDescriptor(dimension={'LENGTH': 2.0}, name='mesh_x_face_area')#
X-component of a mesh face area vector.
- MESH_Y_FACE_AREA = ScalarVariableDescriptor(dimension={'LENGTH': 2.0}, name='mesh_y_face_area')#
Y-component of a mesh face area vector.
- MESH_Z_FACE_AREA = ScalarVariableDescriptor(dimension={'LENGTH': 2.0}, name='mesh_z_face_area')#
Z-component of a mesh face area vector.
- MIXTURE_DENSITY = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -3.0}, name='mixture_density')#
Density of the combined multiphase mixture.
- MOLALITY = ScalarVariableDescriptor(dimension={'CHEMICAL_AMOUNT': 1.0, 'MASS': -1.0}, name='molality')#
Amount of solute per unit mass of solvent.
- MOLARITY = ScalarVariableDescriptor(dimension={'CHEMICAL_AMOUNT': 1.0, 'LENGTH': -3.0}, name='molarity')#
Amount of solute per unit volume of solution.
- MOLAR_ENERGY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -2.0, 'CHEMICAL_AMOUNT': -1.0}, name='molar_energy')#
Energy per mole of substance.
- MOLAR_ENTROPY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -2.0, 'TEMPERATURE': -1.0, 'CHEMICAL_AMOUNT': -1.0}, name='molar_entropy')#
Entropy per mole of substance.
- MOLAR_HEAT_CAPACITY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -2.0, 'TEMPERATURE': -1.0, 'CHEMICAL_AMOUNT': -1.0}, name='molar_heat_capacity')#
Heat required to raise one mole of substance by one degree.
- MOLAR_MASS = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'CHEMICAL_AMOUNT': -1.0}, name='molar_mass')#
Mass of one mole of a substance.
- MOLAR_VOLUME = ScalarVariableDescriptor(dimension={'LENGTH': 3.0, 'CHEMICAL_AMOUNT': -1.0}, name='molar_volume')#
Volume occupied by one mole of a substance.
- MOMENTUM = VectorVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 1.0, 'TIME': -1.0}, name='momentum')#
Product of mass and velocity of a body.
- MOMENTUM_MAGNITUDE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 1.0, 'TIME': -1.0}, name='momentum_magnitude')#
Magnitude of the momentum vector.
- MOMENTUM_X = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 1.0, 'TIME': -1.0}, name='momentum_x')#
Component of momentum along the x-axis.
- MOMENTUM_Y = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 1.0, 'TIME': -1.0}, name='momentum_y')#
Component of momentum along the y-axis.
- MOMENTUM_Z = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 1.0, 'TIME': -1.0}, name='momentum_z')#
Component of momentum along the z-axis.
- MOMENT_OF_INERTIA = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 2.0}, name='moment_of_inertia')#
Resistance of a body to angular acceleration about an axis.
- NERNST_COEFFICIENT = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -1.0, 'TEMPERATURE': -1.0}, name='nernst_coefficient')#
Transverse voltage generated per unit temperature gradient and magnetic field.
- NEUTRON_CROSS_SECTION = ScalarVariableDescriptor(dimension={'LENGTH': 2.0}, name='neutron_cross_section')#
Effective area quantifying the probability of a neutron interaction.
- NORMALIZED_Q_CRITERION = ScalarVariableDescriptor(dimension={}, name='normalized_q_criterion')#
Dimensionless form of the Q-criterion for identifying vortices.
- OPTICAL_ACTIVITY = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'MASS': -1.0}, name='optical_activity')#
Ability of a substance to rotate the plane of polarized light.
- PERMEABILITY = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'MASS': 1.0, 'TIME': -2.0, 'CURRENT': -2.0}, name='permeability')#
Ability of a material to support a magnetic field within it.
- PERMITTIVITY = ScalarVariableDescriptor(dimension={'MASS': -1.0, 'LENGTH': -3.0, 'TIME': 4.0, 'CURRENT': 2.0}, name='permittivity')#
Ability of a material to store electrical energy in an electric field.
- PH = ScalarVariableDescriptor(dimension={}, name='ph')#
Measure of the acidity or alkalinity of a solution.
- PHOTOELASTICITY = ScalarVariableDescriptor(dimension={'MASS': -1.0, 'LENGTH': 1.0, 'TIME': 2.0}, name='photoelasticity')#
Change in a material’s optical properties under mechanical stress.
- PHOTOSENSITIVITY = ScalarVariableDescriptor(dimension={}, name='photosensitivity')#
Degree to which a material responds to incident light.
- PIEZOELECTRIC_CONSTANTS = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -1.0, 'CURRENT': -1.0}, name='piezoelectric_constants')#
Coefficients relating mechanical stress to generated electric field.
- PIEZOMAGNETISM = ScalarVariableDescriptor(dimension={'CURRENT': -1.0, 'LENGTH': 1.0}, name='piezomagnetism')#
Magnetization induced in a material by applied mechanical stress.
- PLASTICITY = ScalarVariableDescriptor(dimension={}, name='plasticity')#
Ability of a material to undergo permanent deformation without fracture.
- POISSON_RATIO = ScalarVariableDescriptor(dimension={}, name='poisson_ratio')#
Ratio of transverse to axial strain in a deformed material.
- POSITION = VectorVariableDescriptor(dimension={'LENGTH': 1.0}, name='position')#
Location of a point in space relative to a reference.
- POSITION_MAGNITUDE = ScalarVariableDescriptor(dimension={'LENGTH': 1.0}, name='position_magnitude')#
Distance of a point from the reference origin.
- POSITION_X = ScalarVariableDescriptor(dimension={'LENGTH': 1.0}, name='position_x')#
Position coordinate along the x-axis.
- POSITION_Y = ScalarVariableDescriptor(dimension={'LENGTH': 1.0}, name='position_y')#
Position coordinate along the y-axis.
- POSITION_Z = ScalarVariableDescriptor(dimension={'LENGTH': 1.0}, name='position_z')#
Position coordinate along the z-axis.
- POWER = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -3.0}, name='power')#
Rate at which energy is transferred or work is done.
- PRANDTL_NUMBER = ScalarVariableDescriptor(dimension={}, name='prandtl_number')#
Ratio of momentum diffusivity to thermal diffusivity in a fluid.
- PRESSURE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='pressure')#
Force applied perpendicular to a surface per unit area.
- PRESSURE_COEFFICIENT = ScalarVariableDescriptor(dimension={}, name='pressure_coefficient')#
Dimensionless number relating local pressure to dynamic pressure.
- PRESSURE_HESSIAN_INDICATOR = ScalarVariableDescriptor(dimension={}, name='pressure_hessian_indicator')#
Pressure-Hessian-based indicator used to drive mesh adaption.
- PRODUCTION_OF_TURBULENT_KINETIC_ENERGY = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -3.0}, name='production_of_turbulent_kinetic_energy')#
Rate at which turbulent kinetic energy is generated in a flow.
- PYROELECTRICITY = ScalarVariableDescriptor(dimension={'CURRENT': 1.0, 'LENGTH': -2.0, 'TEMPERATURE': -1.0}, name='pyroelectricity')#
Generation of electric charge in a material due to temperature change.
- PYROMAGNETIC_COEFFICIENT = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'TIME': -2.0, 'CURRENT': -1.0, 'TEMPERATURE': -1.0}, name='pyromagnetic_coefficient')#
Change in magnetization of a material per unit temperature change.
- Q_CRITERION = ScalarVariableDescriptor(dimension={'TIME': -2.0}, name='q_criterion')#
Vortex identification criterion based on the velocity gradient tensor.
- RADIAL_VELOCITY = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -1.0}, name='radial_velocity')#
Velocity component in the radial direction.
- RADIANCE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'TIME': -3.0, 'SOLID_ANGLE': -1.0}, name='radiance')#
Radiant power per unit solid angle per unit projected area.
- RADIANT_EXPOSURE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'TIME': -2.0}, name='radiant_exposure')#
Radiant energy received per unit area.
- RADIANT_INTENSITY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -3.0, 'SOLID_ANGLE': -1.0}, name='radiant_intensity')#
Radiant power emitted per unit solid angle.
- REACTIVITY = ScalarVariableDescriptor(dimension={}, name='reactivity')#
Tendency of a substance to undergo chemical reaction.
- REFLECTIVITY = ScalarVariableDescriptor(dimension={}, name='reflectivity')#
Fraction of incident radiation reflected by a surface.
- REFRACTIVE_INDEX = ScalarVariableDescriptor(dimension={}, name='refractive_index')#
Ratio of the speed of light in vacuum to its speed in a medium.
- RELATIVE_ATOMIC_MASS = ScalarVariableDescriptor(dimension={}, name='relative_atomic_mass')#
Mass of an atom relative to one-twelfth the mass of carbon-12.
- RESILIENCE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='resilience')#
Energy absorbed per unit volume during elastic deformation.
- SCATTERING = ScalarVariableDescriptor(dimension={}, name='scattering')#
Deflection of radiation or particles by a medium.
- SEEBECK_COEFFICIENT = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 2.0, 'TIME': -3.0, 'CURRENT': -1.0, 'TEMPERATURE': -1.0}, name='seebeck_coefficient')#
Voltage generated per unit temperature difference in a material.
- SHEAR_MODULUS = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='shear_modulus')#
Material’s resistance to shear deformation.
- SHEAR_STRENGTH = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='shear_strength')#
Maximum shear stress a material can withstand before failure.
- SKIN_FRICTION_COEFFICIENT = ScalarVariableDescriptor(dimension={}, name='skin_friction_coefficient')#
Dimensionless wall shear stress normalized by dynamic pressure.
- SLIP = ScalarVariableDescriptor(dimension={}, name='slip')#
Relative motion between contacting surfaces or phases.
- SNAP = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -4.0}, name='snap')#
Rate of change of jerk with respect to time.
- SOLID_ANGLE = ScalarVariableDescriptor(dimension={'SOLID_ANGLE': 1.0}, name='solid_angle')#
Two-dimensional angle subtended at a point by a surface.
- SOUND_REFLECTION = ScalarVariableDescriptor(dimension={}, name='sound_reflection')#
Fraction of incident sound energy reflected by a surface.
- SOUND_TRANSFER = ScalarVariableDescriptor(dimension={}, name='sound_transfer')#
Fraction of sound energy transmitted through a medium.
- SPECIFIC_ACTIVITY = ScalarVariableDescriptor(dimension={'MASS': -1.0, 'TIME': -1.0}, name='specific_activity')#
Radioactive activity per unit mass of a sample.
- SPECIFIC_ANGULAR_MOMENTUM = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -1.0}, name='specific_angular_momentum')#
Angular momentum per unit mass.
- SPECIFIC_DISSIPATION_RATE = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='specific_dissipation_rate')#
Rate of dissipation of turbulent kinetic energy per unit energy.
- SPECIFIC_ENERGY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -2.0}, name='specific_energy')#
Energy per unit mass.
- SPECIFIC_ENTHALPY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -2.0}, name='specific_enthalpy')#
Enthalpy per unit mass.
- SPECIFIC_ENTROPY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -2.0, 'TEMPERATURE': -1.0}, name='specific_entropy')#
Entropy per unit mass.
- SPECIFIC_HEAT_CAPACITY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -2.0, 'TEMPERATURE': -1.0}, name='specific_heat_capacity')#
Heat required to raise unit mass of a substance by one degree.
- SPECIFIC_INTERNAL_ENERGY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -2.0}, name='specific_internal_energy')#
Internal energy per unit mass.
- SPECIFIC_INTERNAL_SURFACE_AREA = ScalarVariableDescriptor(dimension={'LENGTH': -1.0}, name='specific_internal_surface_area')#
Internal surface area per unit volume of a porous material.
- SPECIFIC_MODULUS = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -2.0}, name='specific_modulus')#
Elastic modulus per unit density of a material.
- SPECIFIC_STRENGTH = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -2.0}, name='specific_strength')#
Material strength per unit density.
- SPECIFIC_TOTAL_ENERGY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -2.0}, name='specific_total_energy')#
Total energy per unit mass.
- SPECIFIC_TOTAL_ENTHALPY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -2.0}, name='specific_total_enthalpy')#
Total enthalpy per unit mass.
- SPECIFIC_VOLUME = ScalarVariableDescriptor(dimension={'LENGTH': 3.0, 'MASS': -1.0}, name='specific_volume')#
Volume per unit mass, the inverse of density.
- SPECIFIC_WEIGHT = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -2.0, 'TIME': -2.0}, name='specific_weight')#
Weight per unit volume of a substance.
- SPECTRAL_INTENSITY = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'MASS': 1.0, 'TIME': -3.0, 'SOLID_ANGLE': -1.0}, name='spectral_intensity')#
Radiant intensity per unit wavelength.
- SPECTRAL_IRRADIANCE = ScalarVariableDescriptor(dimension={'LENGTH': -1.0, 'MASS': 1.0, 'TIME': -3.0}, name='spectral_irradiance')#
Radiant power received per unit area per unit wavelength.
- SPECTRAL_POWER = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'MASS': 1.0, 'TIME': -3.0}, name='spectral_power')#
Radiant power per unit wavelength.
- SPEED_OF_SOUND = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -1.0}, name='speed_of_sound')#
Speed at which sound waves propagate through a medium.
- SPIN_HALL_EFFECT = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 2.0, 'TIME': -3.0, 'CURRENT': -2.0}, name='spin_hall_effect')#
Generation of a transverse spin current by an electric field.
- STANDARD_ATOMIC_WEIGHT = ScalarVariableDescriptor(dimension={}, name='standard_atomic_weight')#
Average atomic mass of an element’s isotopes relative to carbon-12.
- STATIC_PRESSURE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='static_pressure')#
Pressure of a fluid at rest relative to the flow.
- STRAIN_RATE = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='strain_rate')#
Rate of deformation of a material per unit time.
- STRESS = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='stress')#
Internal force per unit area within a deformable body.
- SURFACE_ENERGY = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'TIME': -2.0}, name='surface_energy')#
Excess energy at the surface of a material per unit area.
- SURFACE_HEAT_FLUX = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'TIME': -3.0}, name='surface_heat_flux')#
Rate of heat transfer per unit area at a surface.
- SURFACE_HEAT_TRANSFER_COEFFICIENT = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'TIME': -3.0, 'TEMPERATURE': -1.0}, name='surface_heat_transfer_coefficient')#
Heat transfer rate per unit area per unit temperature difference at a surface.
- SURFACE_NUSSELT_NUMBER = ScalarVariableDescriptor(dimension={}, name='surface_nusselt_number')#
Ratio of convective to conductive heat transfer at a surface.
- SURFACE_ROUGHNESS = ScalarVariableDescriptor(dimension={'LENGTH': 1.0}, name='surface_roughness')#
Measure of the fine irregularities on a surface.
- SURFACE_STANTON_NUMBER = ScalarVariableDescriptor(dimension={}, name='surface_stanton_number')#
Ratio of heat transferred to the thermal capacity of the fluid at a surface.
- SURFACE_TENSION = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'TIME': -2.0}, name='surface_tension')#
Elastic tendency of a fluid surface to minimize its area.
- TANGENTIAL_VELOCITY = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -1.0}, name='tangential_velocity')#
Velocity component in the tangential direction.
- TEMPERATURE = ScalarVariableDescriptor(dimension={'TEMPERATURE': 1.0}, name='temperature')#
Measure of the thermal energy or hotness of a body.
- TEMPERATURE_DIFFERENCE = ScalarVariableDescriptor(dimension={'TEMPERATURE_DIFFERENCE': 1.0}, name='temperature_difference')#
Difference between two temperatures.
- TEMPERATURE_GRADIENT = ScalarVariableDescriptor(dimension={'TEMPERATURE': 1.0, 'LENGTH': -1.0}, name='temperature_gradient')#
Rate of temperature change with distance.
- TENSILE_STRENGTH = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='tensile_strength')#
Maximum tensile stress a material can withstand before breaking.
- THERMAL_CONDUCTIVITY = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'MASS': 1.0, 'TIME': -3.0, 'TEMPERATURE': -1.0}, name='thermal_conductivity')#
Ability of a material to conduct heat.
- THERMAL_DIFFUSIVITY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -1.0}, name='thermal_diffusivity')#
Rate at which heat diffuses through a material.
- THERMAL_EXPANSION_COEFFICIENT = ScalarVariableDescriptor(dimension={'TEMPERATURE': -1.0}, name='thermal_expansion_coefficient')#
Fractional change in size of a material per unit temperature change.
- THERMAL_RESISTANCE = ScalarVariableDescriptor(dimension={'TEMPERATURE': 1.0, 'LENGTH': -2.0, 'MASS': -1.0, 'TIME': 3.0}, name='thermal_resistance')#
Resistance of a material to the flow of heat.
- THIRD_ORDER_ELASTICITY = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='third_order_elasticity')#
Higher-order elastic response describing nonlinear stress-strain behavior.
- TIME = ScalarVariableDescriptor(dimension={'TIME': 1.0}, name='time')#
Measure of the progression of events.
- TORQUE = VectorVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -2.0}, name='torque')#
Rotational force that causes a body to rotate about an axis.
- TORQUE_MAGNITUDE = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -2.0}, name='torque_magnitude')#
Magnitude of the torque vector.
- TORQUE_X = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -2.0}, name='torque_x')#
Component of torque about the x-axis.
- TORQUE_Y = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -2.0}, name='torque_y')#
Component of torque about the y-axis.
- TORQUE_Z = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -2.0}, name='torque_z')#
Component of torque about the z-axis.
- TOTAL_ENERGY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'MASS': 1.0, 'TIME': -2.0}, name='total_energy')#
Sum of internal and kinetic energy of a system.
- TOTAL_ENTHALPY_DEVIATION = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -2.0}, name='total_enthalpy_deviation')#
Deviation of total enthalpy from a reference value.
- TOTAL_PRESSURE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='total_pressure')#
Sum of static and dynamic pressure in a flowing fluid.
- TOTAL_TEMPERATURE = ScalarVariableDescriptor(dimension={'TEMPERATURE': 1.0}, name='total_temperature')#
Temperature a fluid attains when brought to rest adiabatically.
- TOUGHNESS = ScalarVariableDescriptor(dimension={'LENGTH': -1.0, 'MASS': 1.0, 'TIME': -2.0}, name='toughness')#
Energy a material can absorb before fracturing.
- TRANSMITTANCE = ScalarVariableDescriptor(dimension={}, name='transmittance')#
Fraction of incident radiation that passes through a material.
- TURBULENT_DISSIPATION_RATE = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': 3.0}, name='turbulent_dissipation_rate')#
Rate at which turbulent kinetic energy is converted to heat.
- TURBULENT_INTENSITY = ScalarVariableDescriptor(dimension={}, name='turbulent_intensity')#
Ratio of velocity fluctuations to the mean flow velocity.
- TURBULENT_KINETIC_ENERGY = ScalarVariableDescriptor(dimension={'LENGTH': 2.0, 'TIME': -2.0}, name='turbulent_kinetic_energy')#
Kinetic energy per unit mass of turbulent velocity fluctuations.
- TURBULENT_REYNOLDS_NUMBER = ScalarVariableDescriptor(dimension={}, name='turbulent_reynolds_number')#
Reynolds number based on turbulent quantities.
- TURBULENT_VISCOSITY = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -1.0}, name='turbulent_viscosity')#
Apparent viscosity arising from turbulent momentum transport.
- TURBULENT_VISCOSITY_RATIO = ScalarVariableDescriptor(dimension={}, name='turbulent_viscosity_ratio')#
Ratio of turbulent to molecular viscosity.
- VAPOR_PRESSURE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='vapor_pressure')#
Pressure exerted by a vapor in equilibrium with its liquid.
- VELOCITY = VectorVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -1.0}, name='velocity')#
Rate of change of position with respect to time.
- VELOCITY_ANGLE = ScalarVariableDescriptor(dimension={'ANGLE': 1.0}, name='velocity_angle')#
Angle of the velocity vector relative to a reference direction.
- VELOCITY_MAGNITUDE = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -1.0}, name='velocity_magnitude')#
Magnitude of the velocity vector (speed).
- VELOCITY_X = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -1.0}, name='velocity_x')#
Component of velocity along the x-axis.
- VELOCITY_Y = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -1.0}, name='velocity_y')#
Component of velocity along the y-axis.
- VELOCITY_Z = ScalarVariableDescriptor(dimension={'LENGTH': 1.0, 'TIME': -1.0}, name='velocity_z')#
Component of velocity along the z-axis.
- VISCOSITY = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -1.0}, name='viscosity')#
Measure of a fluid’s resistance to flow.
- VOLUME = ScalarVariableDescriptor(dimension={'LENGTH': 3.0}, name='volume')#
Amount of three-dimensional space occupied by a substance.
- VOLUMETRIC_FLOW = ScalarVariableDescriptor(dimension={'LENGTH': 3.0, 'TIME': -1.0}, name='volumetric_flow')#
Volume of fluid passing through a section per unit time.
- VOLUME_FRACTION = ScalarVariableDescriptor(dimension={}, name='volume_fraction')#
Fraction of a total volume occupied by a given phase.
- VOLUME_FRACTION_PRIMARY_PHASE = ScalarVariableDescriptor(dimension={}, name='volume_fraction_primary_phase')#
Volume fraction occupied by the primary phase.
- VOLUME_FRACTION_SECONDARY_PHASE = ScalarVariableDescriptor(dimension={}, name='volume_fraction_secondary_phase')#
Volume fraction occupied by the secondary phase.
- VORTICITY = VectorVariableDescriptor(dimension={'TIME': -1.0}, name='vorticity')#
Local spinning motion of a fluid, the curl of the velocity field.
- VORTICITY_MAGNITUDE = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='vorticity_magnitude')#
Magnitude of the vorticity vector.
- VORTICITY_X = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='vorticity_x')#
Component of vorticity about the x-axis.
- VORTICITY_Y = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='vorticity_y')#
Component of vorticity about the y-axis.
- VORTICITY_Z = ScalarVariableDescriptor(dimension={'TIME': -1.0}, name='vorticity_z')#
Component of vorticity about the z-axis.
- WALL_ADJACENT_HEAT_TRANSFER_COEFFICIENT = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'TIME': -3.0, 'TEMPERATURE': -1.0}, name='wall_adjacent_heat_transfer_coefficient')#
Heat transfer coefficient evaluated in the cell adjacent to a wall.
- WALL_ADJACENT_TEMPERATURE = ScalarVariableDescriptor(dimension={'TEMPERATURE': 1.0}, name='wall_adjacent_temperature')#
Fluid temperature in the cell adjacent to a wall.
- WALL_SHEAR_STRESS = VectorVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='wall_shear_stress')#
Shear stress exerted by a fluid on a wall surface.
- WALL_SHEAR_STRESS_MAGNITUDE = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='wall_shear_stress_magnitude')#
Magnitude of the wall shear stress vector.
- WALL_SHEAR_STRESS_X = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='wall_shear_stress_x')#
Component of wall shear stress along the x-axis.
- WALL_SHEAR_STRESS_Y = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='wall_shear_stress_y')#
Component of wall shear stress along the y-axis.
- WALL_SHEAR_STRESS_Z = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='wall_shear_stress_z')#
Component of wall shear stress along the z-axis.
- WALL_TEMPERATURE = ScalarVariableDescriptor(dimension={'TEMPERATURE': 1.0}, name='wall_temperature')#
Temperature at a wall surface.
- WALL_TEMPERATURE_THIN = ScalarVariableDescriptor(dimension={'TEMPERATURE': 1.0}, name='wall_temperature_thin')#
Wall temperature computed for a thin-wall thermal model.
- WALL_Y_PLUS = ScalarVariableDescriptor(dimension={}, name='wall_y_plus')#
Dimensionless wall distance used in turbulence modeling.
- WALL_Y_STAR = ScalarVariableDescriptor(dimension={}, name='wall_y_star')#
Dimensionless wall distance based on turbulent kinetic energy.
- WAVENUMBER = ScalarVariableDescriptor(dimension={'LENGTH': -1.0}, name='wavenumber')#
Number of wave cycles per unit distance.
- YANK = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': 1.0, 'TIME': -3.0}, name='yank')#
Rate of change of force with respect to time.
- YIELD_STRENGTH = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='yield_strength')#
Stress at which a material begins to deform plastically.
- YOUNG_MODULUS = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'LENGTH': -1.0, 'TIME': -2.0}, name='young_modulus')#
Measure of a material’s stiffness under tensile or compressive load.
- Y_PLUS_BASED_HEAT_TRANSFER_COEFFICIENT = ScalarVariableDescriptor(dimension={'MASS': 1.0, 'TIME': -3.0, 'TEMPERATURE': -1.0}, name='y_plus_based_heat_transfer_coefficient')#
Heat transfer coefficient derived from the wall y-plus value.
- class ansys.units.variable_descriptor.VariableDescriptor(dimension: Dimensions)#
Bases:
Generic[QuantityKindT]Defines a physical quantity variable descriptor.
- dimension: Dimensions#
- class ansys.units.variable_descriptor.VectorVariableDescriptor(dimension: Dimensions)#
Bases:
VariableDescriptor[Literal[VECTOR]]Concrete class for vector variables supporting runtime isinstance checks.