CSPropMaterial

class CSXCAD.CSProperties.CSPropMaterial

Bases: CSProperties

General material property

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

Params epsilon:

scalar or vector - relative electric permeability

Params mue:

scalar or vector - relative magnetic permittivity

Params kappa:

scalar or vector - relectric conductivity

Params sigma:

scalar or vector - magnetic conductivity

Params density:

float - Density

GetIsotropy()

Get isotropy status for this material.

Returns:

bool – isotropy status

GetMaterialProperty()

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 permeability

Params mue:

scalar or vector - relative magnetic permittivity

Params kappa:

scalar or vector - relectric 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 cylindircal 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 permeability

Params mue:

str or str-vector - relative magnetic permittivity

Params kappa:

str or str-vector - relectric conductivity

Params sigma:

str or str-vector - magnetic conductivity

Params density:

str - Density