Mag type¶

Mag¶

class rfbp.Mag.BaseMag(x)[source]¶

Bases: object

__add__(m)[source]¶

Sum of mags (overload operator +)

Parameters:	m (mag-like object) – A mag data type is required.
Returns:	mag – The result of the operation
Return type:	BaseMag

__eq__(m)[source]¶

Check mag equality

Parameters:	m (mag-like object) – A mag data type is required.
Returns:	res – The result of the operation
Return type:	bool

__mul__(x)[source]¶

Overload operator * between mag and number

Parameters:	x (float) – This function takes any type of object
Returns:	res – The result of the operation
Return type:	float

__ne__(m)[source]¶

Check mag difference

Parameters:	m (mag-like object) – A mag data type is required.
Returns:	res – The result of the operation
Return type:	bool

__neg__()[source]¶

Overload operator -mag

Returns:	mag – The result of the operation
Return type:	BaseMag

__sub__(m)[source]¶

Overload operator - between mags

Parameters:	m (mag-like object) – A mag data type is required.
Returns:	x – The result of the operation
Return type:	float

Notes

Note

In the operation are involved the “values” of the magnetizations

__truediv__(x)[source]¶

Overload operator /

Parameters:	x (float) – This function takes any type of object

magformat¶

The name of the specialization used

Returns:	name – Name of the specialization
Return type:	str

value¶

The value of the magnetization (it could be equal or processed according to the specialization function)

Returns:	x – The value of the magnetization
Return type:	float