`Material`#

class pyedb.grpc.database.definition.materials.Material(edb: pyedb.grpc.edb.Edb, core)#: Manage EDB methods for material property management.

Overview#

Methods

`set_debye_model`	Set Debye model on current material.
`set_multipole_debye_model`	Set multi-pole debeye model on current material.
`set_djordjecvic_sarkar_model`	Set Djordjecvic-Sarkar model on current material.
`to_dict`	Convert material into dictionary.
`update`
`set_thermal_modifier`	Sets the material property thermal modifier of a given material property.

Properties

`name`	Material name.
`all_properties`	All properties defined in the material definition.
`dc_model`	Dielectric material model.
`dielectric_material_model`	Material dielectric model.
`conductivity`	Get material conductivity.
`dc_conductivity`	Material DC conductivity.
`use_dc_relative_conductivity`	Flag indicating whether the DC relative permittivity nominal value is used.
`dc_relative_permittivity`	Material DC permittivity.
`dc_permittivity`	Material DC permittivity.
`loss_tangent_at_frequency`	Material loss tangent at frequency if dielectric model is defined.
`dielectric_model_frequency`	Dielectric model frequency if model is defined.
`relative_permittivity_at_frequency`	Material relative permittivity at frequency if dielectric model is defined.
`permittivity_at_frequency`	Material permittivity at frequency if model is defined.
`permittivity`	Material permittivity.
`permeability`	Material permeability.
`dielectric_loss_tangent`	Material loss tangent.
`magnetic_loss_tangent`	Material magnetic loss tangent.
`thermal_conductivity`	Material thermal conductivity.
`mass_density`	Material mass density.
`youngs_modulus`	Material young modulus.
`specific_heat`	Material specific heat.
`poisson_ratio`	Material poisson ratio.
`thermal_expansion_coefficient`	Material thermal coefficient.

Attributes

core

Import detail#

from pyedb.grpc.database.definition.materials import Material

Property detail#

property Material.name: str#

Material name.

Returns:

str: Material name.

property Material.all_properties: list[str]#

All properties defined in the material definition.

Returns:

list[str]: List of all material properties available.

property Material.dc_model: ansys.edb.core.definition.debye_model.DebyeModel | ansys.edb.core.definition.multipole_debye_model.MultipoleDebyeModel | ansys.edb.core.definition.djordjecvic_sarkar_model.DjordjecvicSarkarModel | float#

Dielectric material model.

Returns:

DebyeModel, MultipoleDebyeModel, DjordjecvicSarkarModel, or float: The dielectric model object, or 0.0 when no dielectric model is assigned.

property Material.dielectric_material_model: ansys.edb.core.definition.debye_model.DebyeModel | ansys.edb.core.definition.multipole_debye_model.MultipoleDebyeModel | ansys.edb.core.definition.djordjecvic_sarkar_model.DjordjecvicSarkarModel | float#

Material dielectric model.

Returns:

DebyeModel, MultipoleDebyeModel, DjordjecvicSarkarModel, or float: The dielectric model object associated with the material, or 0.0 when no dielectric model is assigned.

property Material.conductivity: float#

Get material conductivity.

Returns:

float: Conductivity value.

property Material.dc_conductivity: float | str | None#

Material DC conductivity.

Returns:

float: DC conductivity value.

property Material.use_dc_relative_conductivity: bool#

Flag indicating whether the DC relative permittivity nominal value is used.

Returns:

bool: Whether the DC relative permittivity nominal value is used.

property Material.dc_relative_permittivity: float | None#

Material DC permittivity.

Returns:

float: DC permittivity value.

property Material.dc_permittivity: float | str | None#: Material DC permittivity.

Deprecated since version 0.71.0: Use :attr: dc_relative_permittivity property instead.

property Material.loss_tangent_at_frequency: float | str | None#

Material loss tangent at frequency if dielectric model is defined.

Returns:

float: Loss tangent value.

property Material.dielectric_model_frequency: float | str | None#

Dielectric model frequency if model is defined.

Returns:

float: Frequency value.

property Material.relative_permittivity_at_frequency: float | str | None#

Material relative permittivity at frequency if dielectric model is defined.

Returns:

float: Permittivity value.

property Material.permittivity_at_frequency: float | str | None#

Material permittivity at frequency if model is defined.

Deprecated since version 0.71.0: Use :attr: relative_permittivity_at_frequency property instead.

Returns:

float: Permittivity value.

property Material.permittivity: float | str | None#

Material permittivity.

Returns:

float: Permittivity value.

property Material.permeability: float | str#

Material permeability.

Returns:

float: Permeability value.

property Material.dielectric_loss_tangent: float | str#

Material loss tangent.

Returns:

float: Loss tangent value.

property Material.magnetic_loss_tangent: float | str#

Material magnetic loss tangent.

Returns:

float: Magnetic loss tangent value.

property Material.thermal_conductivity: float | str#

Material thermal conductivity.

Returns:

float: Thermal conductivity value.

property Material.mass_density: float | str#

Material mass density.

Returns:

float: Mass density value.

property Material.youngs_modulus: float | str#

Material young modulus.

Returns:

float: Material young modulus value.

property Material.specific_heat: float | str#

Material specific heat.

Returns:

float: Material specific heat value.

property Material.poisson_ratio: float | str#

Material poisson ratio.

Returns:

float: Material poisson ratio value.

property Material.thermal_expansion_coefficient: float | str#

Material thermal coefficient.

Returns:

float: Material thermal coefficient value.

Attribute detail#

Material.core#

Method detail#

Material.set_debye_model()#: Set Debye model on current material.

Material.set_multipole_debye_model()#: Set multi-pole debeye model on current material.

Material.set_djordjecvic_sarkar_model()#: Set Djordjecvic-Sarkar model on current material.

Material.to_dict()#: Convert material into dictionary.

Material.update(input_dict: dict)#

Material.set_thermal_modifier(property_name: str, basic_quadratic_temperature_reference: float = 21, basic_quadratic_c1: float = 0.1, basic_quadratic_c2: float = 0.1, advanced_quadratic_lower_limit: float = -270, advanced_quadratic_upper_limit: float = 1001, advanced_quadratic_auto_calculate: bool = False, advanced_quadratic_lower_constant: float = 1.1, advanced_quadratic_upper_constant: float = 1.1)#

Sets the material property thermal modifier of a given material property.

Parameters:

property_namestr: Name of the property to modify.
basic_quadratic_temperature_referencefloat, optional: The TempRef value in the quadratic model.
basic_quadratic_c1float, optional: The C1 value in the quadratic model.
basic_quadratic_c2float, optional: The C2 value in the quadratic model.
advanced_quadratic_lower_limitfloat, optional: The lower temperature limit where the quadratic model is valid.
advanced_quadratic_upper_limitfloat, optional: The upper temperature limit where the quadratic model is valid.
advanced_quadratic_auto_calculatebool, optional: The flag indicating whether or the LowerConstantThermalModifierVal and UpperConstantThermalModifierVal values should be auto calculated.
advanced_quadratic_lower_constantfloat, optional: The constant thermal modifier value for temperatures lower than LowerConstantThermalModifierVal.
advanced_quadratic_upper_constantfloat, optional: The constant thermal modifier value for temperatures greater than UpperConstantThermalModifierVal.

Returns:

Material#

Overview#

Import detail#

Property detail#

Attribute detail#

Method detail#

`Material`#