Material class is used when specifying material properties.
The class can be called from Study or the Application Condition MaterialLibrary class.
. More...

Public Member Functions
Point *	GetAxis ()
	Returns the axis direction as a Point object. More...

Point *	GetAxisForRefAxis ()
	Returns the rotation axis direction for reference axis as a Point object when setting the reference axis separately from the magnetization direction. More...

Point *	GetDirection ()
	Returns the direction vector as a Point object. More...

Point *	GetDirectionForRefAxis ()
	Returns the direction vector for reference axis as a Point object. More...

bool	GetEdgeOrientation ()
	Returns the relation of magnetization edge. More...

String	GetFlagAsString (String &name)
	Returns the flag name set in the specified properties as a string. More...

Variant	GetKeyNames (String &name)
	Returns a list of flags that can be set in the specified properties. More...

Variant	GetListPatterns ()
	Returns the list of pattern names that can be applied to the current material. More...

String	GetLossCoordinatePattern ()
	Returns the the pattern used in an iron loss analysis. More...

Point *	GetMagnetEdgeEndPoint ()
	Returns the end point for magnet edge as a Point object. More...

String	GetMagnetEdgeEndPointUnit ()
	Returns the unit of the end point for magnet edge as a string. More...

Point *	GetMagnetEdgeStartPoint ()
	Returns the start point for magnet edge as a Point object. More...

String	GetMagnetEdgeStartPointUnit ()
	Returns the unit of the start point for magnet edge as a string. More...

double	GetMagnetizationCenterAngle ()
	Returns the angle from the reference axis. More...

String	GetMagnetizationCenterAngleUnit ()
	Returns the unit of the angle from the reference axis as a string. More...

double	GetMagnetizationCenterDistance ()
	Returns the distance from the rotation axis. More...

String	GetMagnetizationCenterDistanceUnit ()
	Returns the unit of the distance from the rotation axis as a string. More...

String	GetMaterialID ()
	Returns the material index as a string. More...

String	GetName ()
	Returns the name of a material as a string. More...

bool	GetOrientation ()
	Returns the magnetization direction. More...

Point *	GetOrigin ()
	Returns the start point as a Point object. More...

Point *	GetOriginForRefAxis ()
	Returns the point on axis for reference axis as a Point object when setting the reference axis separately from the magnetization direction. More...

String	GetOriginUnit ()
	Returns the unit of the start point as a string. More...

String	GetOriginUnitForRefAxis ()
	Returns the unit of the point on axis for reference axis as a string when setting the reference axis separately from the magnetization direction. More...

String	GetPattern ()
	Returns the name of the magnetization pattern. More...

String	GetPropertyHelp (String &propName)
	Returns the property help as a string. More...

Variant	GetPropertyNames ()
	Returns the name list of all properties that can be specified for a material. More...

String	GetPropertyTable ()
	Returns the list of material properties including a type and help. More...

String	GetPropertyType (String &propName)
	Returns a property type. More...

bool	GetReverseAxisDirection ()
	Returns the status of the reverse flag for the axis direction. More...

bool	GetReverseEdgeDirection ()
	Returns the status of the reverse flag for the reference direction. More...

Variant	GetSelectableTemperatures ()
	Returns the selectable temperature as a string list for the magnetic material with [Magnetic Property Type] that is [Nonlinear (Reversible / Temperature dependent)]. More...

String	GetStringValue (String &propName)
	Returns the point sequence of the specified properties as a string. More...

DataSet *	GetTable (String &propName)
	Returns point sequence of the specified properties as a DataSet object. More...

DataSetList *	GetTableList (String &propName)
	Returns multiple point sequences of the specified properties as a DataSetList object. More...

double	GetValue (String &propName)
	Returns a property value as a real number. More...

double	GetValueWithUnit (String &propName, String &unitName)
	Returns the property value as a real number in the specified unit. More...

bool	IsMagnet ()
	Returns True as a return value when the material is a magnet. More...

bool	IsMagnetizationMaterial ()
	Returns whether or not the material is a magnetized material. More...

bool	IsMagnetizedMaterial ()
	Returns whether or not the material is magnetized. More...

bool	IsValid ()
	Returns True as a return value when an object is valid. More...

void	LoadLossData (String &filename)
	Loads material properties from the specified file (*.iron). More...

void	LoadPermeability (String &filename)
	Loads material properties from the specified file (*.hb). More...

void	SetAxis (Point *vector)
	Specifies the axis direction with a Point object. More...

void	SetAxisForRefAxis (Point *vector)
	Specifies the rotation axis direction for reference axis with a Point object when setting the reference axis separately from the magnetization direction. More...

void	SetAxisFromReferenceTarget (ReferenceTarget *ref)
	Specifies the ReferenceTarget object of the edge in the base axis direction of magnetization. More...

void	SetAxisFromReferenceTargetForRefAxis (ReferenceTarget *ref)
	Specifies the ReferenceTarget object of the edge on the rotation axis direction for reference axis. More...

void	SetAxisXYZ (Variant &x, Variant &y, Variant &z)
	Specifies the axis direction using a real number type. More...

void	SetAxisXYZForRefAxis (Variant &x, Variant &y, Variant &z)
	Specifies the rotation axis direction for reference axis using a real number type when setting the reference axis separately from the magnetization direction. More...

void	SetCategory (String &name)
	Specifies the category of a material. More...

void	SetComplexValue (String &propName, double real, double imag)
	Specifies the property value (complex number). More...

void	SetDirection (Point *vector)
	Specifies the direction vector with a Point object. More...

void	SetDirectionForRefAxis (Point *vector)
	Specifies the direction vector for reference axis with a Point object when setting the reference axis separately from the magnetization direction. More...

void	SetDirectionFromReferenceTarget (ReferenceTarget *ref)
	Specifies the ReferenceTarget object of the edge in the direction of magnetization. More...

void	SetDirectionFromReferenceTargetForRefAxis (ReferenceTarget *ref)
	Specifies the ReferenceTarget object of the edge on the base axis direction for reference axis. More...

void	SetDirectionXYZ (Variant &x, Variant &y, Variant &z)
	Specifies the direction using a real number. More...

void	SetDirectionXYZForRefAxis (Variant &x, Variant &y, Variant &z)
	Specifies the direction using a real number. More...

void	SetEdgeOrientation (bool parallelToEdge)
	Specifies the relation of magnetization edge with True or False. More...

void	SetFlagByName (String &propName, String &scriptKeyName)
	Specifies the name to specify the flag property value. More...

void	SetLibrary (String &category, String &libname)
	Specifies a material library. More...

void	SetLossCoordinatePattern (String &pattern)
	Specifies the pattern used in an iron loss analysis for a material. More...

void	SetMagnetEdgeEndPoint (Point *position)
	Specifies a end point on the magnet edge with the Point object. More...

void	SetMagnetEdgeEndPointFromReferenceTarget (ReferenceTarget *ref)
	Specifies the ReferenceTarget object of the vertex on the end point for the magnet edge. More...

void	SetMagnetEdgeEndPointWithUnit (Point *position, String &unitName)
	Specifies a end point on the magnet edge by specifying the units with a Point object. More...

void	SetMagnetEdgeEndPointXYZ (Variant &x, Variant &y, Variant &z)
	Specifies a end point on the magnet edge using a real number type. More...

void	SetMagnetEdgeEndPointXYZWithUnit (Variant &x, Variant &y, Variant &z, String &unitName)
	Specifies a end point on the magnet edge (real number type) by specifying the units. More...

void	SetMagnetEdgeStartPoint (Point *position)
	Specifies a start point on the magnet edge with the Point object. More...

void	SetMagnetEdgeStartPointFromReferenceTarget (ReferenceTarget *ref)
	Specifies the ReferenceTarget object of the vertex on the start point for the magnet edge. More...

void	SetMagnetEdgeStartPointWithUnit (Point *position, String &unitName)
	Specifies a start point on the magnet edge by specifying the units with a Point object. More...

void	SetMagnetEdgeStartPointXYZ (Variant &x, Variant &y, Variant &z)
	Specifies a start point on the magnet edge using a real number type. More...

void	SetMagnetEdgeStartPointXYZWithUnit (Variant &x, Variant &y, Variant &z, String &unitName)
	Specifies a start point on the magnet edge (real number type) by specifying the units. More...

void	SetMagnetizationCenterAngle (Variant &angle)
	Specifies a angle from the reference axis using a real number type. More...

void	SetMagnetizationCenterAngleWithUnit (Variant &angle, String &angleUnitName)
	Specifies a angle from the reference axis (real number type) by specifying the units. More...

void	SetMagnetizationCenterDistance (Variant &distance)
	Specifies a distance from the rotation axis using a real number type. More...

void	SetMagnetizationCenterDistanceWithUnit (Variant &distance, String &distanceUnitName)
	Specifies a distance from the rotation axis (real number type) by specifying the units. More...

void	SetMagnetizationCenterFromArcReferenceTarget (ReferenceTarget *ref)
	Specifies the magnetizaion center from the ReferenceTarget object of the arc. More...

void	SetMagnetizationCenterFromPointReferenceTarget (ReferenceTarget *ref)
	Specifies the magnetizaion center from the ReferenceTarget object of the vertex. More...

void	SetMaterial (String name)
	Specifies a material by specifying a name. The material is not changed if the name does not match. More...

void	SetOrientation (bool outward)
	Specifies the magnetization direction with True or "False". More...

void	SetOrigin (Point *position)
	Specifies a point on the axis with the Point object. More...

void	SetOriginForRefAxis (Point *position)
	Specifies a point on the axis for reference axis with the Point object when setting the reference axis separately from the magnetization direction. More...

void	SetOriginFromReferenceTarget (ReferenceTarget *ref)
	Specifies the ReferenceTarget object of the vertex in the direction of magnetization. More...

void	SetOriginFromReferenceTargetForRefAxis (ReferenceTarget *ref)
	Specifies the ReferenceTarget object of the vertex on the point on axis for reference axis when setting the reference axis separately from the magnetization direction. More...

void	SetOriginWithUnit (Point *position, String &unitName)
	Specifies a point on the axis by specifying the units with a Point object. More...

void	SetOriginWithUnitForRefAxis (Point *position, String &unitName)
	Specifies a point on the axis for reference axis by specifying the units with a Point object when setting the reference axis separately from the magnetization direction. More...

void	SetOriginXYZ (Variant &x, Variant &y, Variant &z)
	Specifies a point on the axis using a real number type. More...

void	SetOriginXYZForRefAxis (Variant &x, Variant &y, Variant &z)
	Specifies a point on the axis for reference axis using a real number type when setting the reference axis separately from the magnetization direction. More...

void	SetOriginXYZWithUnit (Variant &x, Variant &y, Variant &z, String &unitName)
	Specifies a point on the axis (real number type) by specifying the units. More...

void	SetOriginXYZWithUnitForRefAxis (Variant &x, Variant &y, Variant &z, String &unitName)
	Specifies a point on the axis (real number type) for reference axis by specifying the units when setting the reference axis separately from the magnetization direction. More...

void	SetPattern (String &pattern)
	Specifies a pattern to define direction. Specifies magnetization pattern for magnets. More...

void	SetPatternReferenceTarget (ReferenceTarget *ref)
	Specifies the ReferenceTarget object in the direction of magnetization. More...

void	SetPatternReferenceTargetForMagnetEdge (ReferenceTarget *ref)
	Specifies the ReferenceTarget object on the magnet edge when setting the reference axis separately from the magnetization direction. More...

void	SetPatternReferenceTargetForRefAxis (ReferenceTarget *ref)
	Specifies the ReferenceTarget object on the direction for reference axis when setting the reference axis separately from the magnetization direction. More...

void	SetReverseAxisDirection (bool reverse)
	Specifies the reverse flag for the axis direction True or False. More...

void	SetReverseEdgeDirection (bool reverse)
	Specifies the reverse flag for the reference direction True or False. More...

void	SetTable (String &propName, String array &mat)
	Specifies the value of the specified point sequence in properties. More...

void	SetTableFromFile (String &propName, String &filename)
	Specifies a point sequence for a property that is specified, by importing a point sequence file (.csv, .txt, *.pa). More...

void	SetTableList (String &propName, double primaryKey, String &primaryUnitName, String array &mat)
	Specifies a point sequence for the multidimensional array of the specified primary key in the dataset list (multiple point sequences). More...

void	SetTableListName (String &propName, String &name)
	Specifies the name of the dataset list (multiple point sequences). More...

void	SetTableListWithDualKey (String &propName, double primaryKey, String &primaryUnitName, double secondaryKey, String &secondaryUnitName, String array &mat)
	Specifies point sequence for the multidimensional array of the specified primary key and secondary key in the dataset list (multiple point sequences). More...

void	SetTableProperty (String &propName, DataSet *set)
	Specifies point sequence to the specified properties. More...

void	SetValue (String &propName, Variant &value)
	Specifies the property values. More...

void	SetValueWithUnit (String &propName, double value, String &unitName)
	Specifies the value of the property with the specified unit. More...

Detailed Description

Material class is used when specifying material properties.
The class can be called from Study or the Application Condition MaterialLibrary class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetMaterial(0)

For more information about the properties for this class, see Properties for Material Settings .

Member Function Documentation

Point * Material::GetAxis ( )

Returns the axis direction as a Point object.

Returns: Point object

Point * Material::GetAxisForRefAxis ( )

Returns the rotation axis direction for reference axis as a Point object when setting the reference axis separately from the magnetization direction.

Returns: Point object

Point * Material::GetDirection ( )

Returns the direction vector as a Point object.

Returns: Point object

Point * Material::GetDirectionForRefAxis ( )

Returns the direction vector for reference axis as a Point object.

Returns: Point object

bool Material::GetEdgeOrientation ( )

Returns the relation of magnetization edge.

Returns: True=1 : Parallel

False=0 : Perpendicular

String Material::GetFlagAsString ( String & name )

Returns the flag name set in the specified properties as a string.

Parameters

name	Property name

Returns: Flag name

Variant Material::GetKeyNames ( String & name )

Returns a list of flags that can be set in the specified properties.

Parameters

name	Property name

Returns: Flag list

Variant Material::GetListPatterns ( )

Returns the list of pattern names that can be applied to the current material.

Returns: Names of patterns that can be applied

String Material::GetLossCoordinatePattern ( )

Returns the the pattern used in an iron loss analysis.

Returns: Pattern name used in an iron loss analysis

Point * Material::GetMagnetEdgeEndPoint ( )

Returns the end point for magnet edge as a Point object.

Returns: Point object

String Material::GetMagnetEdgeEndPointUnit ( )

Returns the unit of the end point for magnet edge as a string.

Returns: Unit of the end point

Point * Material::GetMagnetEdgeStartPoint ( )

Returns the start point for magnet edge as a Point object.

Returns: Point object

String Material::GetMagnetEdgeStartPointUnit ( )

Returns the unit of the start point for magnet edge as a string.

Returns: Unit of the start point

double Material::GetMagnetizationCenterAngle ( )

Returns the angle from the reference axis.

Returns: Angle from the reference axis

String Material::GetMagnetizationCenterAngleUnit ( )

Returns the unit of the angle from the reference axis as a string.

Returns: Unit of the angle from the reference axis

double Material::GetMagnetizationCenterDistance ( )

Returns the distance from the rotation axis.

Returns: Distance from the rotation axis

String Material::GetMagnetizationCenterDistanceUnit ( )

Returns the unit of the distance from the rotation axis as a string.

Returns: Unit of the distance from the rotation axis

String Material::GetMaterialID ( )

Returns the material index as a string.

Returns: Material ID

String Material::GetName ( )

Returns the name of a material as a string.

Returns: Material name

bool Material::GetOrientation ( )

Returns the magnetization direction.

Returns: True=1 : Clockwise/Outward

False=0 : Counterclockwise/Inward

Point * Material::GetOrigin ( )

Returns the start point as a Point object.

Returns: Point object

Point * Material::GetOriginForRefAxis ( )

Returns the point on axis for reference axis as a Point object when setting the reference axis separately from the magnetization direction.

Returns: Point object

String Material::GetOriginUnit ( )

Returns the unit of the start point as a string.

Returns: Unit of the start point

String Material::GetOriginUnitForRefAxis ( )

Returns the unit of the point on axis for reference axis as a string when setting the reference axis separately from the magnetization direction.

Returns: Unit of the point on axis

String Material::GetPattern ( )

Returns the name of the magnetization pattern.

Returns: Name of the magnetization pattern

String Material::GetPropertyHelp ( String & propName )

Returns the property help as a string.

Parameters

propName Property name

Returns: Property help

Variant Material::GetPropertyNames ( )

Returns the name list of all properties that can be specified for a material.

Returns: Name of the material properties

String Material::GetPropertyTable ( )

Returns the list of material properties including a type and help.

Returns: List of the material properties

String Material::GetPropertyType ( String & propName )

Returns a property type.

Parameters

propName Property name

Returns: Property type

bool Material::GetReverseAxisDirection ( )

Returns the status of the reverse flag for the axis direction.

Returns: True=1 : Reversed

False=0 : Not Reversed

bool Material::GetReverseEdgeDirection ( )

Returns the status of the reverse flag for the reference direction.

Returns: True=1 : Reversed

False=0 : Not Reversed

Variant Material::GetSelectableTemperatures ( )

Returns the selectable temperature as a string list for the magnetic material with [Magnetic Property Type] that is [Nonlinear (Reversible / Temperature dependent)].

Returns: List of selectable temperatures

For the temperature unit, the unit applied to the model is used.

String Material::GetStringValue ( String & propName )

Returns the point sequence of the specified properties as a string.

Parameters

propName Property name

Returns: Property value

DataSet * Material::GetTable ( String & propName )

Returns point sequence of the specified properties as a DataSet object.

Parameters

propName Property name

Returns: DataSet object

DataSetList * Material::GetTableList ( String & propName )

Returns multiple point sequences of the specified properties as a DataSetList object.

Parameters

propName Property name

Returns: DataSetList object

Properties of TableList type described in Properties for Material Settings is used for the property name.

double Material::GetValue ( String & propName )

Returns a property value as a real number.

Parameters

propName Property name

Returns: Property value

double Material::GetValueWithUnit	(	String &	propName,
		String &	unitName
	)

Returns the property value as a real number in the specified unit.

Parameters

propName	Property name
unitName	Unit

Returns: Property value

bool Material::IsMagnet ( )

Returns True as a return value when the material is a magnet.

Returns: Whether or not the material is a magnet

bool Material::IsMagnetizationMaterial ( )

Returns whether or not the material is a magnetized material.

Returns: Whether or not the material is a magnetized material

bool Material::IsMagnetizedMaterial ( )

Returns whether or not the material is magnetized.

Returns: Whether or not the material is magnetized

bool Material::IsValid ( )

Returns True as a return value when an object is valid.

Returns: Whether or not the Material object is valid

void Material::LoadLossData ( String & filename )

Loads material properties from the specified file (*.iron).

Parameters

filename File path

void Material::LoadPermeability ( String & filename )

Loads material properties from the specified file (*.hb).

Parameters

filename File path

void Material::SetAxis ( Point * vector )

Specifies the axis direction with a Point object.

Parameters

vector Point object

void Material::SetAxisForRefAxis ( Point * vector )

Specifies the rotation axis direction for reference axis with a Point object when setting the reference axis separately from the magnetization direction.

Parameters

vector Point object

void Material::SetAxisFromReferenceTarget ( ReferenceTarget * ref )

Specifies the ReferenceTarget object of the edge in the base axis direction of magnetization.

Parameters

reference ReferenceTarget object

void Material::SetAxisFromReferenceTargetForRefAxis ( ReferenceTarget * ref )

Specifies the ReferenceTarget object of the edge on the rotation axis direction for reference axis.

Parameters

reference ReferenceTarget object

void Material::SetAxisXYZ	(	Variant &	x,
		Variant &	y,
		Variant &	z
	)

Specifies the axis direction using a real number type.

Parameters

x	X component of the axis direction
y	Y component of the axis direction
z	Z component of the axis direction

void Material::SetAxisXYZForRefAxis	(	Variant &	x,
		Variant &	y,
		Variant &	z
	)

Specifies the rotation axis direction for reference axis using a real number type when setting the reference axis separately from the magnetization direction.

Parameters

x	X component of the axis direction
y	Y component of the axis direction
z	Z component of the axis direction

void Material::SetCategory ( String & name )

Specifies the category of a material.

Parameters

name Category

void Material::SetComplexValue	(	String &	propName,
		double	real,
		double	imag
	)

Specifies the property value (complex number).

Parameters

propName	Property name
value	Property value (real part)
value	Property value (imaginary part)

void Material::SetDirection ( Point * vector )

Specifies the direction vector with a Point object.

Parameters

vector Point object

void Material::SetDirectionForRefAxis ( Point * vector )

Specifies the direction vector for reference axis with a Point object when setting the reference axis separately from the magnetization direction.

Parameters

vector Point object

void Material::SetDirectionFromReferenceTarget ( ReferenceTarget * ref )

Specifies the ReferenceTarget object of the edge in the direction of magnetization.

Parameters

reference ReferenceTarget object

void Material::SetDirectionFromReferenceTargetForRefAxis ( ReferenceTarget * ref )

Specifies the ReferenceTarget object of the edge on the base axis direction for reference axis.

Parameters

reference ReferenceTarget object

void Material::SetDirectionXYZ	(	Variant &	x,
		Variant &	y,
		Variant &	z
	)

Specifies the direction using a real number.

Parameters

x	X component of the direction vector
y	Y component of the direction vector
z	Z component of the direction vector

void Material::SetDirectionXYZForRefAxis	(	Variant &	x,
		Variant &	y,
		Variant &	z
	)

Specifies the direction using a real number.

Parameters

x	X component of the direction vector
y	Y component of the direction vector
z	Z component of the direction vector

void Material::SetEdgeOrientation ( bool parallelToEdge )

Specifies the relation of magnetization edge with True or False.

Parameters

parallelToEdge

True=1 : Parallel

False=0 : Perpendicular

void Material::SetFlagByName	(	String &	propName,
		String &	scriptKeyName
	)

Specifies the name to specify the flag property value.

Parameters

propName	Property name
scriptKeyName	Flag name

void Material::SetLibrary	(	String &	category,
		String &	libname
	)

Specifies a material library.

Parameters

category	Category name
libname	Library name

void Material::SetLossCoordinatePattern ( String & pattern )

Specifies the pattern used in an iron loss analysis for a material.

Parameters

pattern Pattern name

void Material::SetMagnetEdgeEndPoint ( Point * position )

Specifies a end point on the magnet edge with the Point object.

Parameters

position Point object (end point)

void Material::SetMagnetEdgeEndPointFromReferenceTarget ( ReferenceTarget * ref )

Specifies the ReferenceTarget object of the vertex on the end point for the magnet edge.

Parameters

reference ReferenceTarget object

void Material::SetMagnetEdgeEndPointWithUnit	(	Point *	position,
		String &	unitName
	)

Specifies a end point on the magnet edge by specifying the units with a Point object.

Parameters

position	Point object (end point)
unitName	Unit

void Material::SetMagnetEdgeEndPointXYZ	(	Variant &	x,
		Variant &	y,
		Variant &	z
	)

Specifies a end point on the magnet edge using a real number type.

Parameters

x	X component of the point
y	Y component of the point
z	Z component of the point

void Material::SetMagnetEdgeEndPointXYZWithUnit	(	Variant &	x,
		Variant &	y,
		Variant &	z,
		String &	unitName
	)

Specifies a end point on the magnet edge (real number type) by specifying the units.

Parameters

x	X component of the point
y	Y component of the point
z	Z component of the point
unitName	Unit

void Material::SetMagnetEdgeStartPoint ( Point * position )

Specifies a start point on the magnet edge with the Point object.

Parameters

position Point object (start point)

void Material::SetMagnetEdgeStartPointFromReferenceTarget ( ReferenceTarget * ref )

Specifies the ReferenceTarget object of the vertex on the start point for the magnet edge.

Parameters

reference ReferenceTarget object

void Material::SetMagnetEdgeStartPointWithUnit	(	Point *	position,
		String &	unitName
	)

Specifies a start point on the magnet edge by specifying the units with a Point object.

Parameters

position	Point object (start point)
unitName	Unit

void Material::SetMagnetEdgeStartPointXYZ	(	Variant &	x,
		Variant &	y,
		Variant &	z
	)

Specifies a start point on the magnet edge using a real number type.

Parameters

x	X component of the point
y	Y component of the point
z	Z component of the point

void Material::SetMagnetEdgeStartPointXYZWithUnit	(	Variant &	x,
		Variant &	y,
		Variant &	z,
		String &	unitName
	)

Specifies a start point on the magnet edge (real number type) by specifying the units.

Parameters

x	X component of the point
y	Y component of the point
z	Z component of the point
unitName	Unit

void Material::SetMagnetizationCenterAngle ( Variant & angle )

Specifies a angle from the reference axis using a real number type.

Parameters

angle Angle from the reference axis

void Material::SetMagnetizationCenterAngleWithUnit	(	Variant &	angle,
		String &	angleUnitName
	)

Specifies a angle from the reference axis (real number type) by specifying the units.

Parameters

angle	Angle from the reference axis
angleUnitName	Unit

void Material::SetMagnetizationCenterDistance ( Variant & distance )

Specifies a distance from the rotation axis using a real number type.

Parameters

distance Distance from the rotation axis

void Material::SetMagnetizationCenterDistanceWithUnit	(	Variant &	distance,
		String &	distanceUnitName
	)

Specifies a distance from the rotation axis (real number type) by specifying the units.

Parameters

distance	Distance from the rotation axis
distanceUnitName	Unit

void Material::SetMagnetizationCenterFromArcReferenceTarget ( ReferenceTarget * ref )

Specifies the magnetizaion center from the ReferenceTarget object of the arc.

Parameters

reference ReferenceTarget object

void Material::SetMagnetizationCenterFromPointReferenceTarget ( ReferenceTarget * ref )

Specifies the magnetizaion center from the ReferenceTarget object of the vertex.

Parameters

reference ReferenceTarget object

void Material::SetMaterial ( String name )

Specifies a material by specifying a name. The material is not changed if the name does not match.

Parameters

name	Material name

Multi-byte characters can be used for the material name.

void Material::SetOrientation ( bool outward )

Specifies the magnetization direction with True or "False".

Parameters

outward

True=1 : Clockwise/outward

False=0 : Counterclockwise/inward

void Material::SetOrigin ( Point * position )

Specifies a point on the axis with the Point object.

Parameters

position Point object (start point)

void Material::SetOriginForRefAxis ( Point * position )

Specifies a point on the axis for reference axis with the Point object when setting the reference axis separately from the magnetization direction.

Parameters

position Point object (start point)

void Material::SetOriginFromReferenceTarget ( ReferenceTarget * ref )

Specifies the ReferenceTarget object of the vertex in the direction of magnetization.

Parameters

reference ReferenceTarget object

void Material::SetOriginFromReferenceTargetForRefAxis ( ReferenceTarget * ref )

Specifies the ReferenceTarget object of the vertex on the point on axis for reference axis when setting the reference axis separately from the magnetization direction.

Parameters

reference ReferenceTarget object

void Material::SetOriginWithUnit	(	Point *	position,
		String &	unitName
	)

Specifies a point on the axis by specifying the units with a Point object.

Parameters

position	Point object (start point)
unitName	Unit

void Material::SetOriginWithUnitForRefAxis	(	Point *	position,
		String &	unitName
	)

Specifies a point on the axis for reference axis by specifying the units with a Point object when setting the reference axis separately from the magnetization direction.

Parameters

position	Point object (start point)
unitName	Unit

void Material::SetOriginXYZ	(	Variant &	x,
		Variant &	y,
		Variant &	z
	)

Specifies a point on the axis using a real number type.

Parameters

x	X component of the point
y	Y component of the point
z	Z component of the point

void Material::SetOriginXYZForRefAxis	(	Variant &	x,
		Variant &	y,
		Variant &	z
	)

Specifies a point on the axis for reference axis using a real number type when setting the reference axis separately from the magnetization direction.

Parameters

x	X component of the point
y	Y component of the point
z	Z component of the point

void Material::SetOriginXYZWithUnit	(	Variant &	x,
		Variant &	y,
		Variant &	z,
		String &	unitName
	)

Specifies a point on the axis (real number type) by specifying the units.

Parameters

x	X component of the point
y	Y component of the point
z	Z component of the point
unitName	Unit

void Material::SetOriginXYZWithUnitForRefAxis	(	Variant &	x,
		Variant &	y,
		Variant &	z,
		String &	unitName
	)

Specifies a point on the axis (real number type) for reference axis by specifying the units when setting the reference axis separately from the magnetization direction.

Parameters

x	X component of the point
y	Y component of the point
z	Z component of the point
unitName	Unit

void Material::SetPattern ( String & pattern )

Specifies a pattern to define direction. Specifies magnetization pattern for magnets.

Specifies a lamination or anisotropic direction pattern for soft magnetic materials.

Parameters

pattern

Pattern name

The magnetization pattern name of magnets are as follows:

Pattern_name	Description
PerElements	Specifies the magnetization direction for each element
Parallel	Parallel anisotropic pattern
Radial	Radial anisotropic pattern
Spherical	Spherical anisotropic pattern
ParallelCircular	Parallel pattern (circular direction)
RadialCircular	Radial pattern (circular direction)
PolarCircular	Polar anisotropy pattern (circular direction)
AxisCircular	Axial pattern (circular direction)
ParallelRectilinear	Parallel pattern (rectilinear)
PolarRectilinear	Polar pattern (rectilinear)
AxialPolarCircular	Axial polar anisotropic pattern (circular direction)
RadialSineCircular	Sinusoidal radial pattern (circular direction)
AxialSineCircular	Sinusoidal axial pattern (circular direction)
ParallelSineRectilinear	Sinusoidal parallel pattern (circular direction)
ParallelSineCircular	Sinusoidal parallel pattern (rectilinear)
AnySpecifiedRectangular	Any specified rectangular
AnySpecifiedCylindrical	Any specified cylindrical
AnySpecifiedRectangularTemperature	Any specified rectangular (temperature)
AnySpecifiedCylindricalTemperature	Any specified cylindrical (temperature)
ParallelCircularAnyDirection	Parallel pattern (circular any direction)
RadialCircularAnyMagnetizationCenter	Radial pattern (circular any radial center)
Circular	Circumferenctial anisotropic pattern
ParallelCircularHalbachArray	Parallel pattern (circular Halbach array)
AxisCircularHalbachArray	Axial pattern (circular Halbach array)
ParallelRectilinearHalbachArray	Parallel pattern (rectilinear Halbach array)

The direction pattern name of soft magnetic materials are as follows:

Pattern_name	Description
Parallel	Rectangular coordinate system
CircularRTheta	Cylindrical coordinate system (Z direction) Cylindrical coordinate system (R-theta) Cylindrical coordinate system (ZR-theta)
Radial	Cylindrical coordinate system (R direction)
Circular	Cylindrical coordinate system (theta direction)
Angle	Angle from X-axis
CircularThetaR	Cylindrical coordinate system (theta-R)
CircularThetaZ	Cylindrical coordinate system (theta-Z) Cylindrical coordinate system (R theta-Z)
CircularZTheta	Cylindrical coordinate system (Z-theta)
CircularRZ	Cylindrical coordinate system (R-Z)
CircularZR	Cylindrical coordinate system (Z-R) Cylindrical coordinate system (theta Z-R)
User	User subroutine

void Material::SetPatternReferenceTarget ( ReferenceTarget * ref )

Specifies the ReferenceTarget object in the direction of magnetization.

Parameters

reference ReferenceTarget object

void Material::SetPatternReferenceTargetForMagnetEdge ( ReferenceTarget * ref )

Specifies the ReferenceTarget object on the magnet edge when setting the reference axis separately from the magnetization direction.

Parameters

reference ReferenceTarget object

void Material::SetPatternReferenceTargetForRefAxis ( ReferenceTarget * ref )

Specifies the ReferenceTarget object on the direction for reference axis when setting the reference axis separately from the magnetization direction.

Parameters

reference ReferenceTarget object

void Material::SetReverseAxisDirection ( bool reverse )

Specifies the reverse flag for the axis direction True or False.

Parameters

reverse

True=1 : Reversed

False=0 : Not Reversed

void Material::SetReverseEdgeDirection ( bool reverse )

Specifies the reverse flag for the reference direction True or False.

Parameters

reverse

True=1 : Reversed

False=0 : Not Reversed

void Material::SetTable	(	String &	propName,
		String array &	tableList
	)

Specifies the value of the specified point sequence in properties.

Parameters

propName	Property name
tableList	Multidimensional array

void Material::SetTableFromFile	(	String &	propName,
		String &	filename
	)

Specifies a point sequence for a property that is specified, by importing a point sequence file (*.csv, *.txt, *.pa).

Parameters

propName	Property name
filename	Path for file that is imported

void Material::SetTableList	(	String &	propName,
		double	primaryKey,
		String &	primaryUnitName,
		String array &	tableList
	)

Specifies a point sequence for the multidimensional array of the specified primary key in the dataset list (multiple point sequences).

Parameters

propName	Property name
primaryKey	Value of the primary key
primaryUnitName	Unit name of the primary key
tableList	Multidimensional array

void Material::SetTableListName	(	String &	propName,
		String &	name
	)

Specifies the name of the dataset list (multiple point sequences).

Parameters

propName	Property name
name	Dataset list name

void Material::SetTableListWithDualKey	(	String &	propName,
		double	primaryKey,
		String &	primaryUnitName,
		double	secondaryKey,
		String &	secondaryUnitName,
		String array &	tableList
	)

Specifies point sequence for the multidimensional array of the specified primary key and secondary key in the dataset list (multiple point sequences).

Parameters

propName	Property name
primaryKey	Value of the primary key
primaryUnitName	Unit name of the primary key
secondaryKey	Value of the secondary key
secondaryUnitName	Unit name of the secondary key
tableList	Table (multidimensional point sequences)

void Material::SetTableProperty	(	String &	propName,
		DataSet *	set
	)

Specifies point sequence to the specified properties.

Parameters

propName	Property name
mat	DataSet object

void Material::SetValue	(	String &	propName,
		Variant &	value
	)

Specifies the property values.

Parameters

propName	Property name
value	Property value

void Material::SetValueWithUnit	(	String &	propName,
		double	value,
		String &	unitName
	)

Specifies the value of the property with the specified unit.

Parameters

propName	Property name
value	Property value
unitName	Unit

Public Member Functions

Detailed Description

Member Function Documentation