CSPropMaterial

class CSXCAD.CSProperties.CSPropMaterial

Bases: CSXCAD.CSProperties.CSProperties

General material property

This is a material with options to define relative electric permittivity (epsilon), relative magnetic permeability (mue), electric conductivity (kappa), magnetic conductivity (sigma) and density.

Params epsilon: scalar or vector - relative electric permittivity
Params mue: scalar or vector - relative magnetic permeability
Params kappa: scalar or vector - electric conductivity
Params sigma: scalar or vector - magnetic conductivity
Params density: float - Density

GetIsotropy()

Get isotropy status for this material.

Returns: bool – isotropy status

GetMaterialProperty(prop_name)

SetMaterialProperty(prop_name) Get the material property with of type prop_name.

Params prop_name: str – material property type
Returns: float for isotropic material and density or else (3,) array

GetMaterialWeight(prop_name)

Get the material weighting function(s).

Params prop_name: str – material property type
Returns: str for isotropic material and density or else str array

SetIsotropy(val)

Set isotropy status for this material.

Parameters: val – bool – enable/disable isotropy

SetMaterialProperty(**kw)

Set the material properties.

Params epsilon: scalar or vector - relative electric permittivity
Params mue: scalar or vector - relative magnetic permeability
Params kappa: scalar or vector - electric conductivity
Params sigma: scalar or vector - magnetic conductivity
Params density: float - Density

SetMaterialWeight(**kw)

Set the material weighting function(s)

The functions can use the variables: x,`y`,`z` rho for the distance to z-axis r for the distance to origin a for alpha or phi (as in cylindrical and spherical coord systems) t for theta (as in the spherical coord system

all these variables are not weighted with the drawing unit defined by the grid

Params epsilon: str or str-vector - relative electric permittivity
Params mue: str or str-vector - relative magnetic permeability
Params kappa: str or str-vector - electric conductivity
Params sigma: str or str-vector - magnetic conductivity
Params density: str - Density