InterParameter#

class InterParameter#

Bases: object

Represent a physical material parameter which acts between different regions, i.e. inter_exchange.

__init__(impl)#

Initialize a python InterParameter from a C++ InterParameter instance.

InterParameters should only have to be initialized within the mumax⁺ module and not by the end user.

eval()#

Evaluate the quantity. Return a numpy array containing a symmetric matrix where each region index corresponds to a row/column index. The elements of this matrix correspond to the values of self between the two regions.

property name: str#

Return instance’s name.

property unit: str#

Return unit of the quantity.

property ncomp: int#

Return the number of components of the quantity.

property number_of_regions: int#

Return the number of regions between which the quantity is active.

property region_indices: list[int]#

Return list of unique region indices.

property is_uniform: bool#

Return True if an InterParameter instance is uniform, otherwise False.

See also

uniform_value

property uniform_value: float#

Return the uniform value of the InterParameter instance if it exists.

See also

is_uniform

set(value)#

Set the InterParameter value between every different region to the same value.

See also

set_between

set_between(i, j, value)#

Set InterParameter value between regions i and j.

See also

get_between, set

get_between(i, j)#

Get the InterParameter value between regions i and j.

See also

set_between

Return type:

float